gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079)
Fix Sphinx warnings in library/tty.rst
(cherry picked from commit c42c68aa7b)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` (GH-109424)
(cherry picked from commit 8898a8683b)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
GH-104395: Add a link in 'Meta Information' to the docs download page (GH-104443)
(cherry picked from commit 90cf345ed4)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Resolve reference warnings in faq/gui.rst (GH-108147)
(cherry picked from commit 8f3d09bf5d)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Resolve reference warnings in faq/gui.rst
---------
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678)
(cherry picked from commit c7cef54631)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Docs: Resolve Sphinx warnings in dis.rst (GH-108476)
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb1184280b)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
(cherry picked from commit d7202e4879)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Improve references in the tutorial (GH-108069)
* Use full qualified names for references (even if they do not work now,
they will work in future).
* Silence references to examples.
(cherry picked from commit 622ddc4167)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Resolve reference warnings in faq/library.rst (GH-108149)
(cherry picked from commit 6323bc33ff)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Resolve reference warnings in faq/design.rst (GH-108148)
(cherry picked from commit 92815cc7cf)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit 29fa7afef9)
- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
- sys._emscripten_info
- sys.hash_info
- sys.int_info
- sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
add links to the frame objects reference.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Resolve reference warnings in faq/programming.rst (GH-108150)
(cherry picked from commit a390ec20f5)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
gh-101100: Only show GitHub check annotations on changed doc paragraphs (GH-108065)
* Only show GitHub check annotations on changed doc paragraphs
* Improve check-warnings script arg parsing following Hugo's suggestions
* Factor filtering warnings by modified diffs into helper function
* Build docs on unmerged branch so warning lines match & avoid deep clone
---------
(cherry picked from commit eb953d6e44)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-101100: Docs: Check Sphinx warnings and fail if improved (#106460)
(cherry picked from commit 806d7c98a5)
* [3.12] gh-101100: Docs: Check Sphinx warnings and fail if improved (GH-106460).
(cherry picked from commit 806d7c98a5)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
---------
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Docs: Fix Sphinx warnings in io.rst (GH-107903)
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.
(cherry picked from commit 5c76899dad)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: T. Wouters <thomas@python.org>
Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708)
(cherry picked from commit 8c9af6b9a0)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694)
(cherry picked from commit 9564e31cbc)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Docs: Only include Plausible for html, not for epub etc (GH-107637)
Only include Plausible for html, not for epub etc
(cherry picked from commit 904b5319b3)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Declare the following functions as macros, since they are actually
macros. It avoids a warning on "TYPE" or "macro" argument.
* PyMem_New()
* PyMem_Resize()
* PyModule_AddIntMacro()
* PyModule_AddStringMacro()
* PyObject_GC_New()
* PyObject_GC_NewVar()
* PyObject_New()
* PyObject_NewVar()
Add C standard C types to nitpick_ignore in Doc/conf.py:
* int64_t
* uint64_t
* uintptr_t
No longer ignore non existing "__int" type in nitpick_ignore.
Update Doc/tools/.nitignore.
(cherry picked from commit 8d61a71f9c)
Co-authored-by: Victor Stinner <vstinner@python.org>
