summaryrefslogtreecommitdiffstats
path: root/Doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Add Plausible for docs metrics (#119977)Hugo van Kemenade2024-06-071-1/+2
| | | | Co-authored-by: Julien Palard <julien@palard.fr>
* gh-119009: Add gettext target (#119006)Rafael Fontenelle2024-05-151-0/+2
|
* gh-118689: Doc: fix ePub build (#118690)Inada Naoki2024-05-101-0/+4
|
* gh-111997: C-API for signalling monitoring events (#116413)Irit Katriel2024-05-041-0/+1
|
* gh-117928: Bump the minimum Sphinx version to 6.2.1 (#117853)Kirill Podoprigora2024-04-261-2/+2
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* Docs: add link roles with Sphinx extlinks (#117850)Hugo van Kemenade2024-04-151-0/+16
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-101100: Fix broken xrefs in fcntl module doc (#115691)Skip Montanaro2024-02-251-0/+2
| | | | | | | | | | | | | | | | | | | | | * clean up fcntl module doc * simplify * a few changes, based on suggestion by CAM-Gerlach * nitpick ignore for a couple other C functions mentioned in the fcntl module doc * more changes, especially related to LOCK_* constants * :data: back to :const: * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> --------- Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` (#115580)Hugo van Kemenade2024-02-171-0/+1
| | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Docs: Use substitutions instead of manual version updates (#115416)Hugo van Kemenade2024-02-141-0/+2
|
* Update "Using Python on a Mac" (#115024)Hugo van Kemenade2024-02-131-0/+4
|
* gh-110850: Add PyTime_t C API (GH-115215)Petr Viktorin2024-02-121-5/+8
| | | | | | | | | | | | * gh-110850: Add PyTime_t C API Add PyTime_t API: * PyTime_t type. * PyTime_MIN and PyTime_MAX constants. * PyTime_AsSecondsDouble(), PyTime_Monotonic(), PyTime_PerfCounter() and PyTime_GetSystemClock() functions. Co-authored-by: Victor Stinner <vstinner@python.org>
* Set `hosted_on` for Read the Docs builds (#114697)Hugo van Kemenade2024-01-291-18/+19
|
* gh-85984: Add POSIX pseudo-terminal functions. (GH-102413)Soumendra Ganguly2024-01-291-0/+5
| | | | | Signed-off-by: Soumendra Ganguly <soumendraganguly@gmail.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* gh-101100: Fix datetime reference warnings (GH-114661)Skip Montanaro2024-01-291-0/+5
| | | Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Retain shorter tables of contents for Sphinx 5.2.3+ (#114318)Hugo van Kemenade2024-01-191-0/+4
| | | Disable toc_object_entries, new in Sphinx 5.2.3
* gh-101100: Fix various Sphinx warnings for dunder references in the ↵Alex Waygood2023-12-151-0/+1
| | | | `library/` directory (#113163)
* gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (#113116)Alex Waygood2023-12-141-1/+2
|
* gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and ↵Alex Waygood2023-12-141-0/+4
| | | | `reference/simple_stmts.rst` (#113107)
* gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are ↵Alex Waygood2023-12-071-0/+4
| | | | referenced (#112833)
* gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (#112662)Alex Waygood2023-12-031-0/+3
|
* Docs: Use sphinx-notfound-page to show a nicer 404 page (#111084)Hugo van Kemenade2023-12-021-1/+7
|
* Docs: Add the time to the HTML last updated format (#110091)Adam Turner2023-11-151-3/+2
|
* GH-109209: Bump the minimum Sphinx version to 4.2 (#109210)Adam Turner2023-09-211-1/+1
|
* GH-107987: Remove the Distributing Python Modules guide (#108016)Adam Turner2023-08-171-2/+0
|
* gh-107298: Add standard exceptions and warnings in the nitpick_ignore list ↵Serhiy Storchaka2023-08-171-0/+71
| | | | (GH-108029)
* Docs: Fix more Sphinx annotations in ctypes.rst (#107708)Erlend E. Aasland2023-08-071-0/+1
|
* Docs: Fix Sphinx annotations in Doc/library/ctypes.rst (#107672)Erlend E. Aasland2023-08-061-0/+2
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-107298: Fix more Sphinx warnings in the C API doc (#107329)Victor Stinner2023-07-271-1/+4
| | | | | | | | | | | | | | | | | | | | | | | 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
* gh-107091: Fix some uses of :c:type: role (GH-107138)Serhiy Storchaka2023-07-261-0/+4
|
* gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295)Victor Stinner2023-07-261-0/+9
| | | | | | | | | | | 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>
* gh-106948: Docs: Disable links for C standard library functions, OS utility ↵Erlend E. Aasland2023-07-231-0/+18
| | | | | functions and system calls (#107062) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-106948: Add standard external names to nitpick_ignore (GH-106949)Serhiy Storchaka2023-07-221-0/+52
| | | | | It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".
* gh-75552: Remove deprecated tkinter.tix module (GH-104902)Zachary Ware2023-05-271-1/+0
|
* 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
|