summaryrefslogtreecommitdiffstats
path: root/Doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] Set `hosted_on` for Read the Docs builds (GH-114697) (#114735)Miss Islington (bot)2024-01-291-18/+19
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix datetime reference warnings (GH-114661) (GH-114718)Serhiy Storchaka2024-01-291-0/+5
| | | | | (cherry picked from commit e8b8f5e9c2da6a436360ce648061c90bdfcba863) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.11] Retain shorter tables of contents for Sphinx 5.2.3+ (GH-114318) (#114338)Miss Islington (bot)2024-01-201-0/+4
|
* [3.11] gh-101100: Fix various Sphinx warnings for dunder references in the ↵Miss Islington (bot)2023-12-151-0/+1
| | | | | | `library/` directory (GH-113163) (#113184) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` ↵Miss Islington (bot)2023-12-141-1/+2
| | | | | | | | (GH-113116) (#113137) gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116) (cherry picked from commit 006355b2a966060541166608ecfec4c957b85f55) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and ↵Miss Islington (bot)2023-12-141-0/+4
| | | | | | | | `reference/simple_stmts.rst` (GH-113107) (#113110) gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107) (cherry picked from commit 4b3cb082da82da744f5db0b7315aa80558c51557) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are ↵Alex Waygood2023-12-071-0/+4
| | | | | referenced (#112833) (#112858) (cherry-picked from commit 2c3906bc4b)
* [3.11] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) ↵Miss Islington (bot)2023-12-031-0/+3
| | | | | | | | (#112667) gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) (cherry picked from commit 45650d1c479a8b0370f126d821718dd3c502f333) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] Docs: Add the time to the HTML last updated format (GH-110091) (#112103)Miss Islington (bot)2023-11-151-3/+2
| | | | | | Docs: Add the time to the HTML last updated format (GH-110091) (cherry picked from commit 6c214dea7c503eb42bd130d43e8880f39bff0350) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109637)Miss Islington (bot)2023-09-211-1/+1
| | | | | | GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (cherry picked from commit 712cb173f8e1d02c625a40ae03bba57b0c1c032a) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-107987: Remove the Distributing Python Modules guide (GH-108016) ↵Adam Turner2023-08-181-2/+0
| | | | | | (#108091) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-107298: Add standard exceptions and warnings in the nitpick_ignore ↵Miss Islington (bot)2023-08-171-0/+71
| | | | | | | list (GH-108029) (GH-108071) (cherry picked from commit c9d83f93d804b80ee14480466ebee63a6f97dac2) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) ↵Serhiy Storchaka2023-07-281-1/+4
| | | | | | | | | | | | | | | | | | | (GH-107377) 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() (cherry picked from commit 8d61a71f9c81619e34d4a30b625922ebc83c561b) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)Miss Islington (bot)2023-07-261-0/+4
| | | | | (cherry picked from commit 6d5b6e71c87fca7c5c26f5dd8f325087962215cc) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain ↵Victor Stinner2023-07-261-0/+9
| | | | | | | | | | | | | | | | (#107295) (#107299) gh-106948: Update documentation nitpick_ignore for c:identifer domain (#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. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit b1de3807b832b72dfeb66dd5646159d08d2cc74a)
* [3.11] gh-106948: Docs: Disable links for C standard library functions, OS ↵Erlend E. Aasland2023-07-231-0/+18
| | | | | | | utility functions and system calls (#107062) (#107157) (cherry picked from commit b447e19e720e6781025432a40eb72b1cc93ac944) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) ↵Serhiy Storchaka2023-07-231-0/+52
| | | | | | | (#107061) 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)
* [3.11] GH-97950: Allow translation of index directive content (GH-104000) ↵Miss Islington (bot)2023-05-041-0/+5
| | | | | | (#104151) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)Rafael Fontenelle2023-05-021-3/+21
| | | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Fix redirected permanently URLs (#104001)
* [3.11] Replace Netlify with Read the Docs build previews (#103843) (#104083)Hugo van Kemenade2023-05-021-0/+9
| | | | | Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.11] gh-101100: Fix Sphinx warnings in `argparse` module (#103289) (#103803)Hugo van Kemenade2023-04-241-0/+7
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.11] GH-103484: Fix broken links reported by linkcheck (GH-103608) (#103683)Rafael Fontenelle2023-04-231-0/+18
| | | | | | | Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Fix broken links reported by linkcheck (#103608)
* GH-103484: Docs: add linkcheck allowed redirects entries for most cases ↵Miss Islington (bot)2023-04-181-3/+8
| | | | | | | | (GH-103569) (cherry picked from commit f39e00f9521a0d412a5fc9a50f2a553ec2bb1a7c) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Docs: don't render files in includes/, they're for embedding only (GH-103313)Miss Islington (bot)2023-04-111-1/+3
| | | | | (cherry picked from commit 280bd536b58d3e844047cd132159cf9f6cb66708) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Doc: Fix minor error in ePub (GH-100614)Inada Naoki2023-03-011-3/+3
| | | | Fix issue reported https://mail.python.org/archives/list/docs@python.org/message/KE7OIAO53P4XRC4ZOWPDHA63ZQJCHEC3/ (cherry picked from commit 7d1d66341838d7d1963c9ee7ffca2950d3a751fd)
* Use sphinxext-opengraph to generate OpenGraph metadata (GH-99931)Miss Islington (bot)2022-12-081-4/+30
| | | | | | (cherry picked from commit f49c735e525cf031ddbfc19161aafac4fb18837b) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.11] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97976)Miss Islington (bot)2022-10-061-25/+0
| | | | | | | Also, disable using invalid sphinx-lint 0.6.2. (cherry picked from commit f612565bd32d4ab0945798da775eea070f08b6fe) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* gh-97740: Fix bang in Sphinx C domain ref target syntax (GH-97741)Miss Islington (bot)2022-10-031-0/+15
| | | | | | | | | | | | * gh-97740: Fix bang in Sphinx C domain ref target syntax Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> * Add NEWS entry for C domain bang fix Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> (cherry picked from commit 9148c0d893c7807331fd7be0997261e289074bc5) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message ↵Miss Islington (bot)2022-08-031-0/+7
| | | | | | | (GH-95607) (cherry picked from commit ac3bf6155f8addc62f9a9c48f07eef8c3a6f71b2) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Miss Islington (bot)2022-06-211-2/+0
| | | | | | | | | | | | * Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)" This reverts commit 5c1f15b4b1024cbf0acc85832f0c623d1a4605fd * Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)" This reverts commit b63a620014b67a6e63d10783149c41baaf59def8. (cherry picked from commit 0efe3a1636c143fe0694a8e4d25d6eae19e0d618) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93561)Miss Islington (bot)2022-06-071-1/+1
| | | | | (cherry picked from commit 57e8ee7086bf3f5c50c901e9d5896275644bbb54) Co-authored-by: Davide Rizzo <sorcio@gmail.com>
* Doc: Fix spurious comma in the author metadata field (GH-32386)CAM Gerlach2022-04-071-1/+1
| | | Signed-off-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)Hugo van Kemenade2022-03-301-3/+1
|
* [doc] Add license_url for python-docs-theme 2022.1. (GH-30527)Julien Palard2022-01-111-1/+2
|
* Update URLs in comments and metadata to use HTTPS (GH-27458)Noah Kantrowitz2021-07-301-1/+1
|
* bpo-43795: PEP 652 user documentation (GH-25668)Petr Viktorin2021-05-111-1/+2
| | | | | | - Reformat the C API and ABI Versioning page (and extend/clarify a bit) - Rewrite the stable ABI docs into a general text on C API Compatibility - Add a list of Limited API contents, and notes for the individual items. - Replace `Include/README.rst` with a link to a devguide page with the same info
* bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)Julien Palard2021-01-251-0/+2
|
* bpo-34398: Allow glossary results to show up on search page (GH-8773)Ammar Askar2020-12-181-2/+1
|
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844)Victor Stinner2020-08-121-0/+10
| | | | | Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3.
* bpo-40939: Use the new grammar for the grammar specification documentation ↵Pablo Galindo2020-07-271-1/+1
| | | | | | | (GH-19969) (We censor the heck out of actions and some other stuff using a custom "highlighter".) Co-authored-by: Guido van Rossum <guido@python.org>
* bpo-40517: Implement syntax highlighting support for ASDL (GH-19967)Batuhan Taskaya2020-05-071-1/+2
|
* Revert "bpo-40517: Implement syntax highlighting support for ASDL (#19928)" ↵Raymond Hettinger2020-05-061-2/+1
| | | | | (#19950) This reverts commit d60040ba226bd2e3b6f58d074015aa2499dc1cb8.
* bpo-40517: Implement syntax highlighting support for ASDL (#19928)Batuhan Taskaya2020-05-061-1/+2
|
* Include subsections in TOC for PDF version of docs. (GH-9629)Cheryl Sabella2020-02-181-0/+1
|
* Doc: Keep the venv/* exclude pattern. (GH-15229)Julien Palard2019-08-261-2/+4
| | | In case it has been previously created.
* bpo-36567: Use manpages_url to create links for man pages (GH-13339)Batuhan Taşkaya2019-05-181-0/+3
|
* bpo-36007: Bump minimum sphinx version to 1.8 (GH-11887)Anthony Sottile2019-02-151-2/+2
| | | https://bugs.python.org/issue36007
* bpo-35564: add master_doc='contents' to conf.py (GH-11290)Jean-François B2018-12-221-0/+2
|
* Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423)Adrian Liaw2018-11-041-2/+7
|
* bpo-34962: make doctest in Doc/ now passes, and is enforced in CI (GH-9806)Stéphane Wirtel2018-10-121-0/+7
|