summaryrefslogtreecommitdiffstats
path: root/Doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are ↵Alex Waygood2023-12-071-0/+4
| | | | | referenced (#112833) (#112857) (cherry-picked from commit 2c3906bc4b)
* [3.12] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) ↵Miss Islington (bot)2023-12-031-0/+3
| | | | | | | | (#112666) 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.12] Docs: Add the time to the HTML last updated format (GH-110091) (#112102)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.12] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109636)Miss Islington (bot)2023-09-221-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.12] gh-107298: Add standard exceptions and warnings in the nitpick_ignore ↵Miss Islington (bot)2023-08-171-0/+71
| | | | | | | | list (GH-108029) (#108070) gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029) (cherry picked from commit c9d83f93d804b80ee14480466ebee63a6f97dac2) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] GH-107987: Remove the Distributing Python Modules guide (GH-108016) ↵Miss Islington (bot)2023-08-171-2/+0
| | | | | | | | (#108081) GH-107987: Remove the Distributing Python Modules guide (GH-108016) (cherry picked from commit 33e6e3fec02ff3035dec52692542d3dd10124bef) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708) (#107717)Miss Islington (bot)2023-08-161-0/+1
| | | | | | 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] Docs: Fix Sphinx annotations in Doc/library/ctypes.rst (GH-107672) ↵Miss Islington (bot)2023-08-061-0/+2
| | | | | | | | | (#107685) Docs: Fix Sphinx annotations in Doc/library/ctypes.rst (GH-107672) (cherry picked from commit 71a7c96ffeb0d7fef06be3e57468896e030967a5) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) ↵Serhiy Storchaka2023-07-281-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | (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-107091: Fix some uses of :c:type: role (GH-107138) (GH-107312)Miss Islington (bot)2023-07-261-0/+4
| | | | | (cherry picked from commit 6d5b6e71c87fca7c5c26f5dd8f325087962215cc) 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-0/+9
| | | | | | | | | | | | | | | | | | (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] gh-106948: Docs: Disable links for C standard library functions, OS ↵Miss Islington (bot)2023-07-231-0/+18
| | | | | | | | 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-106948: Add standard external names to nitpick_ignore (GH-106949) ↵Serhiy Storchaka2023-07-231-0/+52
| | | | | | | | | | | | | | (#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
* GH-97950: Allow translation of index directive content (#104000)Adam Turner2023-05-041-0/+5
|
* GH-103484: Fix redirected permanently URLs (#104001)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>
* Replace Netlify with Read the Docs build previews (#103843)Hugo van Kemenade2023-04-301-5/+6
| | | | | Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101100: Fix Sphinx warnings in `argparse` module (#103289)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>
* GH-103484: Fix broken links reported by linkcheck (#103608)Rafael Fontenelle2023-04-221-0/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Doc: Fix broken links reported by linkcheck * Apply suggestions from code review - Remove extra diff line in faq/library.rst (merwok) - Use HTTPS to link Unicode 15.0.0 to solve a redirect (hugovk) - Use wayback machine link for openssl 1.1.0 instead of linking 1.1.1, "as this text mentions a feature from 1.1.0" (hugovk) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Make mark-up code as literal * Doc: Alphabetize items in linkcheck_ignore Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Improve comment in sphinx conf Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --------- 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>
* GH-103484: Docs: add linkcheck allowed redirects entries for most cases ↵Rafael Fontenelle2023-04-181-3/+8
| | | | | | (#103569) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Docs: don't render files in includes/, they're for embedding only (#103313)Hugo van Kemenade2023-04-111-1/+3
|
* 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/
* bpo-37860: re-add netlify.toml to set up deploy previews for docs (#92852)Ashwin Ramaswami2022-12-061-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | * Revert "bpo-46184: remove `netlify.toml` (#30272)" This reverts commit fbaf2e604cd354f1ebc6be029480010c6715a8ca. * Delete runtime.txt * Create runtime.txt * Delete runtime.txt * Update netlify.toml * Update netlify.toml * Add netlify badge * Update Doc/tools/templates/layout.html Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update layout.html Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Use sphinxext-opengraph to generate OpenGraph metadata (#99931)Hugo van Kemenade2022-12-051-4/+30
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-92584: Remove the distutils package (#99061)Victor Stinner2022-11-031-1/+0
| | | | | | | | | | | | Remove the distutils package. It was deprecated in Python 3.10 by PEP 632 "Deprecate distutils module". For projects still using distutils and cannot be updated to something else, the setuptools project can be installed: it still provides distutils. * Remove Lib/distutils/ directory * Remove test_distutils * Remove references to distutils * Skip test_check_c_globals and test_peg_generator since they use distutils
* gh-93738: Disallow pre-v3 syntax in the C domain (#97962)Adam Turner2022-10-061-25/+0
| | | Also, disable using invalid sphinx-lint 0.6.2.
* gh-97740: Fix bang in Sphinx C domain ref target syntax (#97741)C.A.M. Gerlach2022-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>
* gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message ↵CAM Gerlach2022-08-031-0/+7
| | | | (GH-95607)
* Doctest cleanups (GH-95436)Zachary Ware2022-07-301-0/+5
| | | | | | | | | | | | | * GHA: Don't hide doctest output * Enable doctests in math.rst * Squash warnings in nntplib.rst doctests * Squash warning in turtle.rst doctest * Squash warnings in whatsnew/3.2.rst doctests * Treat warnings as errors in Doc/ doctests
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Adam Turner2022-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.
* gh-86986: bump min sphinx version to 3.2 (GH-93337)Davide Rizzo2022-06-071-1/+1
|
* 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
|
* bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)animalize2018-10-081-1/+1
| | | | | Let .chm document display non-ASCII characters properly Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
generated by cgit v0.12 at 2025-02-07 00:21:17 (GMT)