summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-101100: Fix sphinx warnings in `library/site.rst` (GH-110144) ↵Hugo van Kemenade2023-10-021-2/+0
| | | | | | | | (#110187) (cherry picked from commit 31097df611bb5c8084190202e095ae47e8b81c0f) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` ↵Miss Islington (bot)2023-09-291-1/+0
| | | | | | | | | (GH-109424) (#110084) gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` (GH-109424) (cherry picked from commit 8898a8683b5631c24d51a6a7babf55a255874950) Co-authored-by: Maciej Olko <maciej.olko@affirm.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074) ↵Miss Islington (bot)2023-09-291-1/+0
| | | | | | | | (#110081) gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074) (cherry picked from commit d102d39bbe175f179f28e4d4bea99dc122da5f8e) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) ↵Miss Islington (bot)2023-09-281-1/+0
| | | | | | | | | (#109937) gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (cherry picked from commit 3538930d87e6bdd2bfffa3f674a62cc91d359d31) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-101100: Fix sphinx warnings in `library/devmode.rst` (GH-109963) ↵Miss Islington (bot)2023-09-271-1/+0
| | | | | | | | | (#109966) gh-101100: Fix sphinx warnings in `library/devmode.rst` (GH-109963) (cherry picked from commit d9809e84fbf22ed8d90b212a9322260f7074bc9c) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` ↵Hugo van Kemenade2023-09-261-1/+0
| | | | | | | | (GH-109881) (#109884) [3.12] gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` (GH-109881). (cherry picked from commit 7c61a361fc2e93375e22849fffbc20b60e94dbde) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix sphinx warnings in ↵Miss Islington (bot)2023-09-241-1/+0
| | | | | | | | | | | `Doc/library/xml.etree.elementtree.rst` (GH-109799) (#109800) gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` (GH-109799) (cherry picked from commit 649768fb6781ba810df44017fee1975a11d65e2f) gh-101100: Fix shpinx warnings in `Doc/library/xml.etree.elementtree.rst` Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394) (#109416)Miss Islington (bot)2023-09-141-1/+0
| | | | | | gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394) (cherry picked from commit 21e80f4c1925aaafae199840f8737b5c39a82c70) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] GH-104395: Add a link in 'Meta Information' to the docs download page ↵Miss Islington (bot)2023-09-131-0/+1
| | | | | | | | | (GH-104443) (#109345) GH-104395: Add a link in 'Meta Information' to the docs download page (GH-104443) (cherry picked from commit 90cf345ed42ae4d17d2a073718985eb3432a7c20) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] Resolve reference warnings in faq/gui.rst (GH-108147) (#108193)Miss Islington (bot)2023-09-041-1/+0
| | | | | | | | | | | | | | * Resolve reference warnings in faq/gui.rst (GH-108147) (cherry picked from commit 8f3d09bf5d16b508fece5420a22abe6f0c1f00b7) 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>
* [3.12] gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` ↵Nikita Sobolev2023-09-021-1/+0
| | | | | | | | | | | | | | (GH-108810) (#108813) * [3.12] gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` (GH-108810). (cherry picked from commit 5141b1ebe07ad54279e0770b4704eaf76f24951d) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> * Make the requested changes --------- Co-authored-by: AlexWaygood <alex.waygood@gmail.com>
* [3.12] gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) (#108807)Miss Islington (bot)2023-09-021-1/+0
| | | | | | | | | | | | | | | | | | | | * gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) * gh-101100: Fix sphinx warnings in `uuid.rst` * Use anchors (cherry picked from commit 21da4980f5916e8fd648f04367a9e60d141af366) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> * Fix typo * another typo --------- Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Fix sphinx warnings in `tutorial/appendix.rst` (GH-108750) ↵Hugo van Kemenade2023-09-021-1/+0
| | | | | | | | (#108759) (cherry picked from commit 3047f09490ae63f25d57efe1d14a9a65d9b5f6db) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746) ↵Miss Islington (bot)2023-09-011-1/+0
| | | | | | | | (#108756) gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746) (cherry picked from commit e775601ef1ada83a80e1539d0bcd5509deadee14) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684) (#108707)Miss Islington (bot)2023-08-311-1/+0
| | | | | | | gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684) (cherry picked from commit 991e4e76b54b69f227242e73c2ec9d62f903da53) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) ↵Miss Islington (bot)2023-08-301-1/+0
| | | | | | | | (#108680) gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (cherry picked from commit c7cef546319c51defa01236469b636b6978b99ab) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546)Miss Islington (bot)2023-08-271-1/+0
| | | | | | | | | | 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 cb1184280b3fb369a07abb4153aa36829cf1df9b) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-107136: Remove Plausible for docs metrics (GH-107856) (#108334)Miss Islington (bot)2023-08-231-3/+0
| | | | | (cherry picked from commit fc23f34cc9701949e6832eb32f26ea89f6622b82) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-107298: Fix numerous ref errors and typos in the C API docs ↵Miss Islington (bot)2023-08-221-1/+0
| | | | | | | | (GH-108258) (#108284) gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (cherry picked from commit d7202e4879bf4e7e00a69500ddcb3143864139b4) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-107298: Fix C API datetime documentation (GH-108034). (#108234)Serhiy Storchaka2023-08-211-1/+0
| | | (cherry picked from commit d63972e289e05b0d82e59f32f107312a8b3de7b5)
* [3.12] Improve references in the tutorial (GH-108069) (#108203)Miss Islington (bot)2023-08-211-2/+0
| | | | | | | | | | 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 622ddc41674c2566062af82f7b079aa01d2aae8c) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Resolve reference warnings in faq/library.rst (GH-108149) (#108182)Miss Islington (bot)2023-08-201-1/+0
| | | | | | | | Resolve reference warnings in faq/library.rst (GH-108149) (cherry picked from commit 6323bc33ff9f445a947adf4af42b8be7e44c730c) 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>
* [3.12] Resolve reference warnings in faq/design.rst (GH-108148) (#108180)Miss Islington (bot)2023-08-201-1/+0
| | | | | | Resolve reference warnings in faq/design.rst (GH-108148) (cherry picked from commit 92815cc7cf3df8ab702c7cea4efaef349a4b0480) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] Docs: Fix Sphinx warnings in sys.rst (#108106) (#108178)Erlend E. Aasland2023-08-201-1/+0
| | | | | | | | | | | | | | | | | | (cherry picked from commit 29fa7afef94d74e18d97485c085d1ccf80c16ca3) - 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>
* [3.12] Docs: Fix Sphinx warnings in logging.rst (GH-108139) (#108174)Erlend E. Aasland2023-08-201-1/+0
| | | | | (cherry picked from commit c735e79afb62324624864e1943f84825249f58ed) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* [3.12] Resolve reference warnings in faq/programming.rst (GH-108150) (#108170)Miss Islington (bot)2023-08-201-1/+0
| | | | | | Resolve reference warnings in faq/programming.rst (GH-108150) (cherry picked from commit a390ec20f5a85b9c16e8708f117667783d08863c) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] Docs: Fix Sphinx warnings in license.rst (GH-108142) (#108167)Miss Islington (bot)2023-08-201-1/+0
| | | | | | | | | Docs: Fix Sphinx warnings in license.rst (GH-108142) - Fix links to stdlib modules - Silence links to external functions (cherry picked from commit 4d4393139fae39db26dead33529b6ae0bafbfc58) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-101100: Only show GitHub check annotations on changed doc ↵Miss Islington (bot)2023-08-191-22/+184
| | | | | | | | | | | | | | | | | | paragraphs (GH-108065) (#108127) 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 eb953d6e4484339067837020f77eecac61f8d4f8) 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>
* [3.12] gh-101100: Docs: Check Sphinx warnings and fail if improved ↵C.A.M. Gerlach2023-08-184-96/+151
| | | | | | | | | | | | | | | | (GH-106460) (#108116) * gh-101100: Docs: Check Sphinx warnings and fail if improved (#106460) (cherry picked from commit 806d7c98a5da5c1fd2e52a5b666f36ca4f545092) * [3.12] gh-101100: Docs: Check Sphinx warnings and fail if improved (GH-106460). (cherry picked from commit 806d7c98a5da5c1fd2e52a5b666f36ca4f545092) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] Docs: Fix Sphinx warnings in io.rst (GH-107903) (#108093)Miss Islington (bot)2023-08-181-1/+0
| | | | | | | | | | | | 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 5c76899dadf3bdcfdedf6f30b3ab9742cb87af04) 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>
* [3.12] gh-107298: Fix C API Buffer documentation (GH-108011). (#108048)Serhiy Storchaka2023-08-161-1/+0
| | | | | (cherry picked from commit c2941cba7a986e6158eebb2a0bf33906dcd78616) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708) (#107717)Miss Islington (bot)2023-08-161-1/+0
| | | | | | Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708) (cherry picked from commit 8c9af6b9a0d6fc9cb237e96588d8dcab727e32b8) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] GH-84435: Make pyspecific directives translatable (GH-19470) (#107681)Miss Islington (bot)2023-08-061-10/+8
| | | | | | | | GH-84435: Make pyspecific directives translatable (GH-19470) (cherry picked from commit ecb05e0b9842ba03b42b4dec8767b1c18a4e28b3) Co-authored-by: cocoatomo <cocoatomo77@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* [3.12] Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694) ↵Miss Islington (bot)2023-08-061-3/+3
| | | | | | | | (#107695) Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694) (cherry picked from commit 9564e31cbc95a723f2414537231bc4611b56644f) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] Docs: Only include Plausible for html, not for epub etc (GH-107637) ↵Miss Islington (bot)2023-08-041-1/+3
| | | | | | | | | | (#107642) 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 904b5319b3cc72063f4bfcd7beb3a1ef0fc641be) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) ↵Serhiy Storchaka2023-07-291-36/+0
| | | | | (GH-107419) (cherry picked from commit f2d07d3289947d10b065b2bb7670c8fb6b6582f2)
* [3.12] gh-107091: Fix some uses of :const: role (GH-107379) (GH-107384)Miss Islington (bot)2023-07-281-1/+0
| | | | | | It is for references, not for literals. (cherry picked from commit 0aa58fa7a62cd0ee7ec27fa87122425aeff0467d) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) ↵Serhiy Storchaka2023-07-281-4/+0
| | | | | (GH-107380) (cherry picked from commit 983305268e2291b0a7835621b81bf40cba7c27f3)
* [3.12] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) ↵Serhiy Storchaka2023-07-281-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | (GH-107376) 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 8d61a71f9c81619e34d4a30b625922ebc83c561b) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) (GH-107375)Serhiy Storchaka2023-07-281-8/+0
| | | | | (cherry picked from commit 391e03fa05b80d17a14ac88d30c974fa2fa00adb) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-107298: Fix doc references to undocumented modules (GH-107300) ↵Miss Islington (bot)2023-07-281-1/+0
| | | | | | | | (GH-107370) Update also Doc/tools/.nitignore. (cherry picked from commit 87b39028e5f453a949a1675526c439f6479a04a8) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-107298: Docs: add targets for some :c:member: and :c:macro: ↵Miss Islington (bot)2023-07-271-1/+0
| | | | | | | | | | references (GH-107316) (GH-107332) Add targets for PyStructSequence_Desc and PyStructSequence_Field members and macros like Py_EQ. Fix target for Py_RETURN_RICHCOMPARE. (cherry picked from commit abec9a1b20b70d8ced401d59fc4f02b331c6568b) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain ↵Miss Islington (bot)2023-07-261-3/+0
| | | | | | | | | | | | | | | | | | (GH-107295) (#107297) gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. (cherry picked from commit b1de3807b832b72dfeb66dd5646159d08d2cc74a) Co-authored-by: Victor Stinner <vstinner@python.org> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Remove superflous whitespaces in `layout.html`. (#107251)Ezio Melotti2023-07-251-4/+4
| | | Remove superflous whitespaces in layout.html.
* [3.12] gh-106948: Docs: Disable links for C standard library functions, OS ↵Miss Islington (bot)2023-07-231-1/+0
| | | | | | | | utility functions and system calls (GH-107062) (#107154) (cherry picked from commit b447e19e720e6781025432a40eb72b1cc93ac944) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-101100: Fix some broken sphinx references (GH-107095) (#107103)Miss Islington (bot)2023-07-231-10/+0
| | | | | (cherry picked from commit f5147c0cfbd7943ff10917225448c36a53f9828d) Co-authored-by: wulmer <wulmer@users.noreply.github.com>
* [3.12] Convert `doc.yml` workflow to be reusable (GH-103914 + GH-105151) ↵Sviatoslav Sydorenko2023-07-231-6/+27
| | | | | | | | | | (#107042) Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> (cherry picked from commit 88d14da76f579fe014cbd7c15e42be4234135fe9) (cherry picked from commit eaa670228066220f08c8d73f80365c50058d40b8)
* [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) ↵Serhiy Storchaka2023-07-231-8/+0
| | | | | | | | | | | | | | (#107060) * [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH". (cherry picked from commit f8b7fe2f2647813ae8249675a80e59c117d30fe1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> * Delete 2023-05-31-18-37-57.gh-issue-105156.R4El5V.rst
* [3.12] Fix Sphinx warnings in `re` module docs (GH-107044) (#107046)Miss Islington (bot)2023-07-221-1/+0
| | | | | | Fix Sphinx warnings in `re` module docs (GH-107044) (cherry picked from commit 149748ea4f552e6fe43a1d6d69bd65910a7c4813) Co-authored-by: wulmer <wulmer@users.noreply.github.com>
* [3.12] Docs search: Replace jQuery with vanilla JavaScript (GH-106743) (#106802)Miss Islington (bot)2023-07-161-30/+44
| | | | | | | | | Docs search: Replace jQuery with vanilla JavaScript (GH-106743) * Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let' (cherry picked from commit c02ee4503151105dc892018ebc7f633e7f3f62f8) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
generated by cgit v0.12 at 2025-04-15 23:34:53 (GMT)