f5b1510e6b
[3.13] Doc: Note that pydoc uses and prefers ``MANPAGER`` (GH-125362) ( #126152 )
...
Doc: Note that pydoc uses and prefers ``MANPAGER`` (GH-125362)
(cherry picked from commit 0e45b1fd0f
2024-10-29 23:23:18 +00:00
5ce23f2703
[3.13] Add lightweight comments to conf.py and update docs readme (GH-126100) ( #126134 )
...
Add lightweight comments to conf.py and update docs readme (GH-126100)
* Update contributing contact info in readme
* Add lightweight comments to improve docs workflow understanding
* Apply code review suggestions from @hugovk
* Add code review suggestion from @AA-Turner
* Update Doc/conf.py
* Update Doc/conf.py
* Update Doc/conf.py
---------
(cherry picked from commit 9effa0ff06
2024-10-29 19:21:41 +00:00
22ae72b88f
[3.13] Doc: Show object descriptions in the table of contents (GH-125757) ( #125840 )
...
(cherry picked from commit 91ddde4af0
2024-10-22 13:13:35 +00:00
fbbc79ea25
[3.13] GH-125277: Increase minimum supported Sphinx to 7.2.6 (GH-125368) ( #125720 )
2024-10-19 04:23:22 +00:00
4bc59e5fd7
[3.13] Doc: Update CVE URL (GH-125489) ( #125503 )
...
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2024-10-15 07:34:15 +00:00
2019362d95
[3.13] Doc: Upgrade Sphinx to 8.1 (GH-125276) ( #125278 )
...
Doc: Upgrade Sphinx to 8.1 (GH-125276)
(cherry picked from commit dd0ee201da
2024-10-10 20:31:40 +00:00
abb01fd938
[3.13] GH-121970: Extract ``availability`` into a new extension (GH-125082) ( #125237 )
...
(cherry picked from commit cbfd392479
2024-10-10 10:43:43 +00:00
fe58596cce
[3.13] Doc: Fix default ``latex_elements['papersize']`` (GH-124525) ( #124725 )
...
Doc: Fix default ``latex_elements['papersize']`` (GH-124525)
https://www.sphinx-doc.org/en/master/latex.htmlGH-the-latex-elements-configuration-setting
It should be 'letterpaper' or 'a4paper' not 'letter' or 'a4'
(not to be confused with PAPER env variable).
(cherry picked from commit fae5058ec1
2024-09-29 21:23:06 -07:00
6867604781
[3.13] GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) ( #124151 )
...
GH-103484: Fix permanently redirects reported by linkcheck (GH-124144)
Fix redirects reported by linkcheck, update docs conf.py checks.
(cherry picked from commit 0a32c6959c
2024-09-24 00:43:04 +00:00
a439f8531f
[3.13] gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134) ( #124244 )
...
gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)
(cherry picked from commit 32119fc377
2024-09-23 16:22:04 -07:00
86f30dd539
[3.13] GH-109975: Copyedit 3.13 What's New: C API (GH-124313) ( #124334 )
...
* [3.13] GH-109975: Copyedit 3.13 What's New: C API (GH-124313)
(cherry picked from commit 9d0a75269c
2024-09-23 11:14:13 -07:00
3f52fef151
[3.13] GH-103484: Tell linkcheck to ignore debian manpage redirects (GH-123019) ( #124137 )
...
GH-103484: Tell linkcheck to ignore debian manpage redirects (GH-123019)
(cherry picked from commit 1054a755a3
2024-09-23 11:10:59 -07:00
578742a9a1
[3.13] gh-123407: Enable translating literal and code blocks (GH-123408) ( #123530 )
...
gh-123407: Enable translating literal and code blocks (GH-123408)
(cherry picked from commit 5332d989af
2024-08-31 06:49:08 +00:00
ae1bdcafb8
[3.13] GH-121970: Extract ``audit_events`` into a new extension (GH-122325) ( #122434 )
2024-07-30 04:08:35 +00:00
3b013fc208
[3.13] GH-121970: Remove ``escape4chm`` (GH-122065) ( #122167 )
...
GH-121970: Remove ``escape4chm`` (GH-122065)
(cherry picked from commit 53e9e7de63
2024-07-23 12:48:23 +00:00
efc7d1ca86
[3.13] GH-121970: Modernise the patchlevel extension (GH-121995) ( #122060 )
...
GH-121970: Modernise the patchlevel extension (GH-121995)
(cherry picked from commit b7ad711fcb
2024-07-20 14:02:23 +00:00
c12f81ed82
[3.13] GH-121970: Rewrite the C-API annotations extension ( #121985 ) ( #122027 )
...
GH-121970: Rewrite the C-API annotations extension (#121985 )
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit 22c9d9c1fc
2024-07-19 13:03:52 +00:00
1565093374
[3.13] GH-121970: Use Ruff to check and format the docs tools (GH-122018) ( #122023 )
...
GH-121970: Use Ruff to check and format the docs tools (GH-122018)
(cherry picked from commit 40855f3ab8
2024-07-19 12:30:54 +00:00
0d138df3fd
[3.13] GH-121970: Combine custom Pygments lexers into a package (GH-121976) ( #122021 )
...
GH-121970: Combine custom Pygments lexers into a package (GH-121976)
(cherry picked from commit 7431c3799e
2024-07-19 12:11:33 +00:00
d2caf8bee8
[3.13] GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986) ( #121994 )
...
GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986)
(cherry picked from commit 7dd52b63ce
2024-07-19 07:52:42 +00:00
7e5f6be763
[3.13] gh-121871: Allow overriding docs build date with SOURCE_DATE_EPOCH (GH-121872) ( #121888 )
...
Co-authored-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
2024-07-17 00:12:12 -06:00
fcc4a537b9
[3.13] NEWS: Fix Sphinx warnings and increase threshold for new news nits (GH-121482) ( #121513 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-07-13 12:55:43 +00:00
0e6605f633
[3.13] Add Plausible for docs metrics (GH-119977) ( #120193 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Julien Palard <julien@palard.fr>
2024-06-07 10:42:19 +03:00
7c224dd4cc
[3.13] gh-119009: Add gettext target (GH-119006) ( #119074 )
...
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-15 18:31:55 +00:00
760b3f08dc
gh-118689: Doc: fix ePub build (GH-118690)
...
(cherry picked from commit 7ac933e260
2024-05-10 10:40:35 +00:00
85af789961
gh-111997: C-API for signalling monitoring events ( #116413 )
2024-05-04 08:23:50 +00:00
463c20dae9
gh-117928: Bump the minimum Sphinx version to 6.2.1 ( #117853 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-26 13:10:16 +03:00
3375282bb8
Docs: add link roles with Sphinx extlinks ( #117850 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
84a275c4a2
gh-101100: Fix broken xrefs in fcntl module doc ( #115691 )
...
* 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>
2024-02-25 12:02:18 -08:00
4dff48d1f4
gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` ( #115580 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-17 03:03:20 -07:00
46245b0d83
Docs: Use substitutions instead of manual version updates ( #115416 )
2024-02-13 23:55:00 -07:00
0a6e1a4119
Update "Using Python on a Mac" ( #115024 )
2024-02-13 08:31:49 +02:00
879f4546bf
gh-110850: Add PyTime_t C API (GH-115215)
...
* 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>
2024-02-12 18:13:10 +01:00
3996cbdd33
Set `hosted_on` for Read the Docs builds ( #114697 )
2024-01-29 14:24:21 -07:00
e351ca3c20
gh-85984: Add POSIX pseudo-terminal functions. (GH-102413)
...
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>
2024-01-29 16:10:28 +00:00
e8b8f5e9c2
gh-101100: Fix datetime reference warnings (GH-114661)
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-29 16:43:44 +02:00
229ee5bea1
Retain shorter tables of contents for Sphinx 5.2.3+ ( #114318 )
...
Disable toc_object_entries, new in Sphinx 5.2.3
2024-01-19 18:52:42 +00:00
1addde0c69
gh-101100: Fix various Sphinx warnings for dunder references in the `library/` directory ( #113163 )
2023-12-15 19:15:34 +02:00
006355b2a9
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` ( #113116 )
2023-12-14 19:25:55 +00:00
4b3cb082da
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` ( #113107 )
2023-12-14 13:30:57 +00:00
2c3906bc4b
gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced ( #112833 )
2023-12-07 20:57:30 +00:00
45650d1c47
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` ( #112662 )
2023-12-03 17:32:49 +00:00
0229d2a9b1
Docs: Use sphinx-notfound-page to show a nicer 404 page ( #111084 )
2023-12-02 17:41:40 +00:00
6c214dea7c
Docs: Add the time to the HTML last updated format ( #110091 )
2023-11-15 04:04:28 +00:00
712cb173f8
GH-109209: Bump the minimum Sphinx version to 4.2 ( #109210 )
2023-09-21 09:06:36 +03:00
33e6e3fec0
GH-107987: Remove the Distributing Python Modules guide ( #108016 )
2023-08-17 13:01:14 +03:00
c9d83f93d8
gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029)
2023-08-17 09:44:05 +03:00
8c9af6b9a0
Docs: Fix more Sphinx annotations in ctypes.rst ( #107708 )
2023-08-07 15:11:05 +02:00
71a7c96ffe
Docs: Fix Sphinx annotations in Doc/library/ctypes.rst ( #107672 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-06 10:23:50 +02:00
8d61a71f9c
gh-107298: Fix more Sphinx warnings in the C API doc ( #107329 )
...
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
2023-07-27 00:52:40 +00:00
Miss Islington (bot)
Adam Turner
Petr Viktorin
Hugo van Kemenade
Irit Katriel
Kirill Podoprigora
Skip Montanaro
Soumendra Ganguly
Alex Waygood
Hugo van Kemenade
Serhiy Storchaka
Erlend E. Aasland
Victor Stinner