Miss Islington (bot)
7812dc37ab
[3.12] Doc: Note that pydoc uses and prefers `MANPAGER` (GH-125362) ( #126153 )
...
Doc: Note that pydoc uses and prefers ``MANPAGER`` (GH-125362)
(cherry picked from commit 0e45b1fd0f
2024-10-29 23:26:29 +00:00
Miss Islington (bot)
db0a1b8c12
[3.12] Add lightweight comments to conf.py and update docs readme (GH-126100) ( #126135 )
...
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 12:22:38 -07:00
Miss Islington (bot)
98a0b362b5
[3.12] Doc: Show object descriptions in the table of contents (GH-125757) ( #125841 )
...
(cherry picked from commit 91ddde4af0
2024-10-22 13:16:03 +00:00
Miss Islington (bot)
2ce10b1729
[3.12] GH-125277: Increase minimum supported Sphinx to 7.2.6 (GH-125368) ( #125721 )
2024-10-19 04:27:44 +00:00
Miss Islington (bot)
79422bc13b
[3.12] Doc: Update CVE URL (GH-125489) ( #125504 )
...
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2024-10-15 07:36:17 +00:00
Miss Islington (bot)
91c7a2cb89
[3.12] Doc: Upgrade Sphinx to 8.1 (GH-125276) ( #125279 )
...
Doc: Upgrade Sphinx to 8.1 (GH-125276)
(cherry picked from commit dd0ee201da
2024-10-10 20:32:40 +00:00
Adam Turner
caa4924917
[3.12] GH-121970: Extract `availability` into a new extension (GH-125082) ( #125238 )
...
(cherry picked from commit cbfd392479
2024-10-10 09:16:03 +00:00
Miss Islington (bot)
b3360dcaee
[3.12] Doc: Fix default `latex_elements['papersize']` (GH-124525) ( #124726 )
...
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-28 10:38:51 +00:00
Miss Islington (bot)
92bc714033
[3.12] GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) (GH-124152)
...
Fix redirects reported by linkcheck, update docs conf.py checks.
(cherry picked from commit 0a32c6959c
2024-09-16 20:53:46 -07:00
Miss Islington (bot)
1151dd6c73
[3.12] GH-103484: Tell linkcheck to ignore debian manpage redirects (GH-123019) ( #124136 )
...
GH-103484: Tell linkcheck to ignore debian manpage redirects (GH-123019)
(cherry picked from commit 1054a755a3
2024-09-16 18:49:14 +00:00
Miss Islington (bot)
5b3fcc04e3
[3.12] gh-123407: Enable translating literal and code blocks (GH-123408) ( #123531 )
...
gh-123407: Enable translating literal and code blocks (GH-123408)
(cherry picked from commit 5332d989af
2024-08-31 06:38:11 +00:00
Miss Islington (bot)
6b4abdee91
[3.12] GH-121970: Extract `audit_events` into a new extension (GH-122325) ( #122435 )
2024-07-30 03:55:15 +00:00
Miss Islington (bot)
647765395d
[3.12] GH-121970: Remove `escape4chm` (GH-122065) ( #122168 )
...
GH-121970: Remove ``escape4chm`` (GH-122065)
(cherry picked from commit 53e9e7de63
2024-07-23 12:38:43 +00:00
Miss Islington (bot)
ca531e4326
[3.12] GH-121970: Modernise the patchlevel extension (GH-121995) ( #122061 )
...
GH-121970: Modernise the patchlevel extension (GH-121995)
(cherry picked from commit b7ad711fcb
2024-07-20 13:51:32 +00:00
Adam Turner
ff98d9021a
[3.12] GH-121970: Rewrite the C-API annotations extension (GH-121985) ( #122025 )
...
(cherry picked from commit 22c9d9c1fc
2024-07-19 12:48:50 +00:00
Adam Turner
7c8b6f85c9
[3.12] GH-121970: Use Ruff to check and format the docs tools (GH-122018) ( #122024 )
...
(cherry picked from commit 40855f3ab8
2024-07-19 12:26:32 +00:00
Miss Islington (bot)
2cd816e4e0
[3.12] GH-121970: Combine custom Pygments lexers into a package (GH-121976) ( #122022 )
...
GH-121970: Combine custom Pygments lexers into a package (GH-121976)
(cherry picked from commit 7431c3799e
2024-07-19 12:02:42 +00:00
Miss Islington (bot)
eda9b7f6fd
[3.12] GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986) ( #121993 )
...
GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986)
(cherry picked from commit 7dd52b63ce
2024-07-19 07:44:03 +00:00
Miss Islington (bot)
7057d5e270
[3.12] gh-121871: Allow overriding docs build date with SOURCE_DATE_EPOCH (GH-121872) ( #121887 )
...
Co-authored-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
2024-07-17 00:19:09 -06:00
Hugo van Kemenade
377ff9d584
[3.12] NEWS: Fix Sphinx warnings and increase threshold for new news nits (GH-121482) ( #121514 )
...
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:54:50 +00:00
Miss Islington (bot)
92a38e9874
[3.12] Add Plausible for docs metrics (GH-119977) ( #120194 )
...
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:37 +03:00
Miss Islington (bot)
ed395f5c0e
[3.12] gh-119009: Add gettext target (GH-119006) ( #119075 )
...
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-15 18:20:41 +00:00
Miss Islington (bot)
9f8f14a6da
gh-118689: Doc: fix ePub build (GH-118690)
...
(cherry picked from commit 7ac933e260
2024-05-10 19:34:33 +09:00
Kirill Podoprigora
ef12d239fa
[3.12] gh-117928: Bump the minimum Sphinx version to 6.2.1 (GH-117853) ( #118321 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-26 17:18:58 +03:00
Hugo van Kemenade
eb0bfb5910
[3.12] Docs: add link roles with Sphinx extlinks (GH-117850) ( #117910 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 13:18:21 -06:00
Carol Willing
7307b562b0
[3.12] gh-101100: Fix broken xrefs in fcntl module doc (GH-115691) ( #115924 )
...
* 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
---------
(cherry picked from commit 84a275c4a2
2024-02-25 17:27:35 -08:00
Miss Islington (bot)
2763f382f9
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst (GH-115580) ( #115589 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-17 14:18:30 -07:00
Miss Islington (bot)
a30bb080dc
[3.12] Update "Using Python on a Mac" (GH-115024) ( #115387 )
...
Update "Using Python on a Mac" (GH-115024)
(cherry picked from commit 0a6e1a4119
2024-02-13 09:05:46 +02:00
Miss Islington (bot)
424df31f00
[3.12] Set hosted_on for Read the Docs builds (GH-114697) ( #114734 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-29 21:30:22 +00:00
Miss Islington (bot)
783339a086
[3.12] gh-101100: Fix datetime reference warnings (GH-114661) (GH-114716)
...
(cherry picked from commit e8b8f5e9c2
2024-01-29 17:12:03 +02:00
Miss Islington (bot)
6279b2dc15
[3.12] Retain shorter tables of contents for Sphinx 5.2.3+ (GH-114318) ( #114337 )
2024-01-20 10:33:15 +00:00
Miss Islington (bot)
00324a77da
[3.12] gh-101100: Fix various Sphinx warnings for dunder references in the library/ directory (GH-113163) ( #113183 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 17:22:07 +00:00
Miss Islington (bot)
15114517dd
[3.12] gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (GH-113116) ( #113136 )
...
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b2a9
2023-12-14 19:32:30 +00:00
Miss Islington (bot)
dc568dd226
[3.12] gh-101100: Fix Sphinx nitpicks in library/inspect.rst and reference/simple_stmts.rst (GH-113107) ( #113109 )
...
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107)
(cherry picked from commit 4b3cb082da
2023-12-14 13:37:47 +00:00
Alex Waygood
fb02db75cb
[3.12] gh-101100: Silence Sphinx warnings when ntpath or posixpath are referenced ( #112833 ) ( #112857 )
...
(cherry-picked from commit 2c3906bc4b
2023-12-07 21:10:12 +00:00
Miss Islington (bot)
5608112fa9
[3.12] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662) ( #112666 )
...
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47
2023-12-03 17:39:26 +00:00
Miss Islington (bot)
c190552739
[3.12] Docs: Add the time to the HTML last updated format (GH-110091) ( #112102 )
...
Docs: Add the time to the HTML last updated format (GH-110091)
(cherry picked from commit 6c214dea7c
2023-11-15 06:20:14 +01:00
Miss Islington (bot)
9e4ac21c46
[3.12] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) ( #109636 )
...
GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210)
(cherry picked from commit 712cb173f8
2023-09-22 14:30:57 +02:00
Miss Islington (bot)
125aab99ab
[3.12] gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029) ( #108070 )
...
gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029)
(cherry picked from commit c9d83f93d8
2023-08-17 12:52:08 +02:00
Miss Islington (bot)
2576303007
[3.12] GH-107987: Remove the Distributing Python Modules guide (GH-108016) ( #108081 )
...
GH-107987: Remove the Distributing Python Modules guide (GH-108016)
(cherry picked from commit 33e6e3fec0
2023-08-17 12:50:46 +02:00
Miss Islington (bot)
220d7e3120
[3.12] Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708) ( #107717 )
...
Docs: Fix more Sphinx annotations in ctypes.rst (GH-107708)
(cherry picked from commit 8c9af6b9a0
2023-08-16 14:30:58 +02:00
Miss Islington (bot)
e950d70451
[3.12] Docs: Fix Sphinx annotations in Doc/library/ctypes.rst (GH-107672) ( #107685 )
...
Docs: Fix Sphinx annotations in Doc/library/ctypes.rst (GH-107672)
(cherry picked from commit 71a7c96ffe
2023-08-06 22:08:38 +02:00
Serhiy Storchaka
e6a4b10820
[3.12] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) (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 8d61a71f9c
2023-07-28 09:56:52 +03:00
Miss Islington (bot)
da2097dffb
[3.12] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107312)
...
(cherry picked from commit 6d5b6e71c8
2023-07-26 19:37:39 +00:00
Miss Islington (bot)
0d2e1317bd
[3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain (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 b1de3807b8
2023-07-26 18:16:04 +02:00
Miss Islington (bot)
40a337fbaa
[3.12] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (GH-107062) ( #107154 )
...
(cherry picked from commit b447e19e72
2023-07-23 23:13:23 +02:00
Serhiy Storchaka
456cf8b097
[3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) ( #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 f8b7fe2f26
2023-07-23 11:24:51 +02:00
Adam Turner
35d273825a
GH-97950: Allow translation of index directive content ( #104000 )
2023-05-04 10:11:09 +03:00
Rafael Fontenelle
68ed2a2a3f
GH-103484: Fix redirected permanently URLs ( #104001 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
2023-05-02 09:34:44 +03:00
Hugo van Kemenade
accb417c33
Replace Netlify with Read the Docs build previews ( #103843 )
...
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-29 23:02:03 -06:00
