0e45b1fd0f
Doc: Note that pydoc uses and prefers ``MANPAGER`` ( #125362 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-29 23:12:02 +00:00
9effa0ff06
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
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* Add code review suggestion from @AA-Turner
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Update Doc/conf.py
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Update Doc/conf.py
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Update Doc/conf.py
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
---------
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-29 17:45:03 +00:00
91ddde4af0
Doc: Show object descriptions in the table of contents ( #125757 )
2024-10-22 14:07:09 +01:00
2bb7ab7ad3
GH-125277: Increase minimum supported Sphinx to 7.2.6 ( #125368 )
2024-10-19 04:59:22 +01:00
a2fe9ff11d
Doc: Update CVE URL ( #125489 )
2024-10-15 10:29:08 +03:00
dd0ee201da
Doc: Upgrade Sphinx to 8.1 ( #125276 )
2024-10-10 21:26:01 +01:00
cbfd392479
GH-121970: Extract ``availability`` into a new extension ( #125082 )
2024-10-09 21:50:03 +01:00
fae5058ec1
Doc: Fix default ``latex_elements['papersize']`` ( #124525 )
...
https://www.sphinx-doc.org/en/master/latex.html#the-latex-elements-configuration-setting
It should be 'letterpaper' or 'a4paper' not 'letter' or 'a4'
(not to be confused with PAPER env variable).
2024-09-28 11:30:28 +01:00
32119fc377
gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)
2024-09-18 14:15:43 +02:00
0a32c6959c
GH-103484: Fix permanently redirects reported by linkcheck (GH-124144)
...
Fix redirects reported by linkcheck, update docs conf.py checks.
2024-09-17 02:53:38 +00:00
5332d989af
gh-123407: Enable translating literal and code blocks ( #123408 )
2024-08-31 07:31:36 +01:00
4c6dca8292
gh-120389: Add PyLong_FromInt64() and PyLong_AsInt64() ( #120390 )
...
Add new functions to convert C <stdint.h> numbers from/to Python int:
* PyLong_FromInt32()
* PyLong_FromUInt32()
* PyLong_FromInt64()
* PyLong_FromUInt64()
* PyLong_AsInt32()
* PyLong_AsUInt32()
* PyLong_AsInt64()
* PyLong_AsUInt64()
2024-08-28 10:16:13 +00:00
1054a755a3
GH-103484: Tell linkcheck to ignore debian manpage redirects ( #123019 )
2024-08-14 22:35:23 +01:00
11ad731f4f
GH-121970: Extract ``audit_events`` into a new extension ( #122325 )
2024-07-30 03:49:00 +00:00
53e9e7de63
GH-121970: Remove ``escape4chm`` ( #122065 )
2024-07-23 13:30:06 +01:00
b7ad711fcb
GH-121970: Modernise the patchlevel extension ( #121995 )
2024-07-20 13:44:43 +00:00
22c9d9c1fc
GH-121970: Rewrite the C-API annotations extension ( #121985 )
...
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-07-19 12:21:56 +00:00
40855f3ab8
GH-121970: Use Ruff to check and format the docs tools ( #122018 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@gmail.com>
2024-07-19 11:48:53 +00:00
7dd52b63ce
GH-117928: Bump the minimum Sphinx version to 6.2.1 ( #121986 )
2024-07-18 21:05:38 +00:00
7431c3799e
GH-121970: Combine custom Pygments lexers into a package ( #121976 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-07-18 18:38:29 +00:00
941b3b7f44
gh-121871: Allow overriding docs build date with SOURCE_DATE_EPOCH ( #121872 )
2024-07-16 23:34:00 -06:00
006b53a42f
NEWS: Fix Sphinx warnings and increase threshold for new news nits ( #121482 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-07-08 14:30:05 -06:00
5c115567b1
Add Plausible for docs metrics ( #119977 )
...
Co-authored-by: Julien Palard <julien@palard.fr>
2024-06-07 00:38:31 -06:00
fb0cf7d140
gh-119009: Add gettext target ( #119006 )
2024-05-15 12:13:52 -06:00
7ac933e260
gh-118689: Doc: fix ePub build ( #118690 )
2024-05-10 19:24:02 +09: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
Matthieu Ancellin
Carol Willing
Adam Turner
Mariusz Felisiak
Jean-François B.
Petr Viktorin
Rafael Fontenelle
Maciej Olko
Victor Stinner
Bernhard M. Wiedemann
Hugo van Kemenade
Inada Naoki
Irit Katriel
Kirill Podoprigora
Skip Montanaro
Soumendra Ganguly
Alex Waygood
Hugo van Kemenade
Serhiy Storchaka
Erlend E. Aasland