Hugo van Kemenade
ce724571b3
Docs HTML: Remove self-closing tags ( #132220 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-04-07 18:21:13 +03:00
Adam Turner
561965fa5c
Generate social media preview cards for the documentation ( #132101 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2025-04-05 14:20:06 +00:00
Adam Turner
c1a02f9101
GH-121970: Extract pydoc_topics into a new extension ( #131256 )
2025-03-19 18:35:11 +00:00
Hugo van Kemenade
ca1bedc9a4
gh-121970: Revert "GH-121970: Extract `pydoc_topics` into a new extension ( #129116 )" ( #131245 )
...
Revert "GH-121970: Extract ``pydoc_topics`` into a new extension (#129116 )"
This reverts commit 01bcf13a1c
2025-03-14 16:25:56 +02:00
Adam Turner
e53d105872
GH-125722: Increase minimum supported Sphinx to 8.2.0 ( #130444 )
2025-03-05 00:31:01 +00:00
Adam Turner
043ab3af9a
GH-121970: Extract `issue_role` into a new extension ( #130615 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-27 19:06:13 +00:00
Adam Turner
3cc9e867eb
Docs: Test presence of optional extensions with importlib ( #130445 )
2025-02-22 17:52:47 +00:00
Adam Turner
4d56c40440
GH-121970: Extract `implementation_detail` into a new extension ( #129663 )
2025-02-06 16:53:27 +00:00
Petr Viktorin
58a4357e29
gh-127833: Docs: Add a grammar-snippet directive & replace productionlist (GH-127835)
...
As a first step toward aligning the grammar documentation with Python's actual
grammar, this overrides the ReST `productionlist` directive to:
- use `:` instead of the `::=` symbol
- add syntax highlighting for strings (using a Pygments highlighting class)
All links and link targets should be preserved. (Unfortunately, this reaches
into some Sphinx internals; I don't see a better way to do exactly what
Sphinx does.)
This also adds a new directive, `grammar-snippet`, which formats the snippet
almost exactly like what's in the source, modulo syntax highlighting and
keeping the backtick character to mark links to other rules.
This will allow formatting the snippets as in the grammar file
(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).
The new directive is applied to two simple rules in toplevel_components.rst
---------
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: William Ferreira <wqferr@gmail.com>
Co-authored-by: bswck <bartoszpiotrslawecki@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-05 16:12:23 +01:00
Adam Turner
ae4788809d
GH-121970: Extract `misc_news` into a new extension ( #129577 )
2025-02-02 16:17:02 +00:00
partev
a156b19424
gh-126022: Remove zope.org from the permitted linkcheck redirects ( #129308 )
2025-01-26 16:46:00 +02:00
Adam Turner
01bcf13a1c
GH-121970: Extract `pydoc_topics` into a new extension ( #129116 )
2025-01-21 23:28:32 +00:00
Adam Turner
e54ac3b69e
GH-121970: Extract `changes` into a new extension ( #129105 )
2025-01-20 23:53:08 +00:00
Adam Turner
d46b577ec0
GH-125722: Increase minimum supported Sphinx to 8.1.3 ( #128922 )
2025-01-20 00:26:24 +00:00
Hugo van Kemenade
c9d2bc6d7f
Revert "Doc: Show object descriptions in the table of contents ( #125757 )" ( #128406 )
2025-01-02 14:35:00 +00:00
Hugo van Kemenade
23f2e8f13c
gh-127221: Add colour to unittest output ( #127223 )
...
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-12-05 21:10:46 +02:00
Hugo van Kemenade
91f4908798
gh-126133: Only use start year in PSF copyright, remove end years ( #126236 )
2024-11-12 15:59:19 +02:00
Matthieu Ancellin
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
Carol Willing
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
Adam Turner
91ddde4af0
Doc: Show object descriptions in the table of contents ( #125757 )
2024-10-22 14:07:09 +01:00
Adam Turner
2bb7ab7ad3
GH-125277: Increase minimum supported Sphinx to 7.2.6 ( #125368 )
2024-10-19 04:59:22 +01:00
Mariusz Felisiak
a2fe9ff11d
Doc: Update CVE URL ( #125489 )
2024-10-15 10:29:08 +03:00
Adam Turner
dd0ee201da
Doc: Upgrade Sphinx to 8.1 ( #125276 )
2024-10-10 21:26:01 +01:00
Adam Turner
cbfd392479
GH-121970: Extract `availability` into a new extension ( #125082 )
2024-10-09 21:50:03 +01:00
Jean-François B.
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
Petr Viktorin
32119fc377
gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)
2024-09-18 14:15:43 +02:00
Rafael Fontenelle
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
Maciej Olko
5332d989af
gh-123407: Enable translating literal and code blocks ( #123408 )
2024-08-31 07:31:36 +01:00
Victor Stinner
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
Rafael Fontenelle
1054a755a3
GH-103484: Tell linkcheck to ignore debian manpage redirects ( #123019 )
2024-08-14 22:35:23 +01:00
Adam Turner
11ad731f4f
GH-121970: Extract `audit_events` into a new extension ( #122325 )
2024-07-30 03:49:00 +00:00
Adam Turner
53e9e7de63
GH-121970: Remove `escape4chm` ( #122065 )
2024-07-23 13:30:06 +01:00
Adam Turner
b7ad711fcb
GH-121970: Modernise the patchlevel extension ( #121995 )
2024-07-20 13:44:43 +00:00
Adam Turner
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
Adam Turner
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
Adam Turner
7dd52b63ce
GH-117928: Bump the minimum Sphinx version to 6.2.1 ( #121986 )
2024-07-18 21:05:38 +00:00
Adam Turner
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
Bernhard M. Wiedemann
941b3b7f44
gh-121871: Allow overriding docs build date with SOURCE_DATE_EPOCH ( #121872 )
2024-07-16 23:34:00 -06:00
Hugo van Kemenade
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
Hugo van Kemenade
5c115567b1
Add Plausible for docs metrics ( #119977 )
...
Co-authored-by: Julien Palard <julien@palard.fr>
2024-06-07 00:38:31 -06:00
Rafael Fontenelle
fb0cf7d140
gh-119009: Add gettext target ( #119006 )
2024-05-15 12:13:52 -06:00
Inada Naoki
7ac933e260
gh-118689: Doc: fix ePub build ( #118690 )
2024-05-10 19:24:02 +09:00
Irit Katriel
85af789961
gh-111997: C-API for signalling monitoring events ( #116413 )
2024-05-04 08:23:50 +00:00
Kirill Podoprigora
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
Hugo van Kemenade
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
Skip Montanaro
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
Hugo van Kemenade
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
Hugo van Kemenade
46245b0d83
Docs: Use substitutions instead of manual version updates ( #115416 )
2024-02-13 23:55:00 -07:00
Hugo van Kemenade
0a6e1a4119
Update "Using Python on a Mac" ( #115024 )
2024-02-13 08:31:49 +02:00
Petr Viktorin
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
