Commit Graph

118 Commits

Author SHA1 Message Date
Carol Willing 2110ae80fa
[3.11] gh-101100: Fix broken xrefs in fcntl module doc (GH-115691) (#115925)
* 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)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2024-02-26 01:32:52 +00:00
Miss Islington (bot) b87a443146
[3.11] gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` (GH-115580) (#115590)
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:51:28 -07:00
Miss Islington (bot) d87a02223c
[3.11] Update "Using Python on a Mac" (GH-115024) (#115388)
Update "Using Python on a Mac" (GH-115024)
(cherry picked from commit 0a6e1a4119)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-13 09:06:35 +02:00
Miss Islington (bot) 679fe04dc3
[3.11] Set `hosted_on` for Read the Docs builds (GH-114697) (#114735)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-29 21:30:27 +00:00
Serhiy Storchaka c67f94e385
[3.11] gh-101100: Fix datetime reference warnings (GH-114661) (GH-114718)
(cherry picked from commit e8b8f5e9c2)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-01-29 15:20:05 +00:00
Miss Islington (bot) 2e6a3a6378
[3.11] Retain shorter tables of contents for Sphinx 5.2.3+ (GH-114318) (#114338) 2024-01-20 10:33:19 +00:00
Miss Islington (bot) bbc70451e0
[3.11] gh-101100: Fix various Sphinx warnings for dunder references in the `library/` directory (GH-113163) (#113184)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 17:21:59 +00:00
Miss Islington (bot) ba6958522d
[3.11] gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116) (#113137)
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b2a9)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 19:32:37 +00:00
Miss Islington (bot) 3b7b256053
[3.11] gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107) (#113110)
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107)
(cherry picked from commit 4b3cb082da)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 13:37:38 +00:00
Alex Waygood cda1695799
[3.11] gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced (#112833) (#112858)
(cherry-picked from commit 2c3906bc4b)
2023-12-07 21:12:37 +00:00
Miss Islington (bot) 05ea7e5d4d
[3.11] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) (#112667)
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 17:39:10 +00:00
Miss Islington (bot) a92b9e5b2b
[3.11] Docs: Add the time to the HTML last updated format (GH-110091) (#112103)
Docs: Add the time to the HTML last updated format (GH-110091)
(cherry picked from commit 6c214dea7c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-11-15 06:20:17 +01:00
Miss Islington (bot) e918b19f42
[3.11] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109637)
GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210)
(cherry picked from commit 712cb173f8)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-21 06:32:10 +00:00
Adam Turner 6dd1729a88
[3.11] GH-107987: Remove the Distributing Python Modules guide (GH-108016) (#108091)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-18 10:12:07 +03:00
Miss Islington (bot) b8e62cfb01
[3.11] gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029) (GH-108071)
(cherry picked from commit c9d83f93d8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-17 06:54:53 +00:00
Serhiy Storchaka 32e17d4a3c
[3.11] gh-107298: Fix more Sphinx warnings in the C API doc (GH-107329) (GH-107377)
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()

(cherry picked from commit 8d61a71f9c)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-07-28 07:03:47 +00:00
Miss Islington (bot) 603c5d50e8
[3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)
(cherry picked from commit 6d5b6e71c8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-27 00:00:36 +03:00
Victor Stinner bd0def00b3
[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295) (#107299)
gh-106948: Update documentation nitpick_ignore for c:identifer domain (#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.

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit b1de3807b8)
2023-07-26 16:27:08 +00:00
Erlend E. Aasland b3e600a632
[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) (#107157)
(cherry picked from commit b447e19e72)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 23:49:48 +02:00
Serhiy Storchaka ec8718dd7c
[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) (#107061)
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:37 +02:00
Miss Islington (bot) 8f94c9465b
[3.11] GH-97950: Allow translation of index directive content (GH-104000) (#104151)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 10:26:08 +03:00
Rafael Fontenelle 5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001)
2023-05-02 14:50:16 +03:00
Hugo van Kemenade b07bae6971
[3.11] Replace Netlify with Read the Docs build previews (#103843) (#104083)
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-05-02 05:29:27 +00:00
Hugo van Kemenade 9f4364355e
[3.11] gh-101100: Fix Sphinx warnings in `argparse` module (#103289) (#103803)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 22:15:04 +00:00
Rafael Fontenelle 8642fdce8c
[3.11] GH-103484: Fix broken links reported by linkcheck (GH-103608) (#103683)
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>
Fix broken links reported by linkcheck (#103608)
2023-04-23 23:26:15 +03:00
Miss Islington (bot) 1dad3d1071
GH-103484: Docs: add linkcheck allowed redirects entries for most cases (GH-103569)
(cherry picked from commit f39e00f952)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-17 20:06:52 -07:00
Miss Islington (bot) a836d79111
Docs: don't render files in includes/, they're for embedding only (GH-103313)
(cherry picked from commit 280bd536b5)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-10 23:26:07 -07:00
Inada Naoki 90ec292ab8
Doc: Fix minor error in ePub (GH-100614)
Fix issue reported https://mail.python.org/archives/list/docs@python.org/message/KE7OIAO53P4XRC4ZOWPDHA63ZQJCHEC3/
(cherry picked from commit 7d1d663418)
2023-03-01 10:19:16 +09:00
Miss Islington (bot) 0274a3bc3b
Use sphinxext-opengraph to generate OpenGraph metadata (GH-99931)
(cherry picked from commit f49c735e52)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-08 09:34:52 -08:00
Miss Islington (bot) 27a7fe319a
[3.11] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97976)
Also, disable using invalid sphinx-lint 0.6.2.
(cherry picked from commit f612565bd3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-06 10:49:29 -07:00
Miss Islington (bot) 827f77e5f1
gh-97740: Fix bang in Sphinx C domain ref target syntax (GH-97741)
* 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>
(cherry picked from commit 9148c0d893)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-02 21:02:46 -07:00
Miss Islington (bot) a591c4701c
gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message (GH-95607)
(cherry picked from commit ac3bf6155f)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-03 13:43:14 -07:00
Miss Islington (bot) cc42716275
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
(cherry picked from commit 0efe3a1636)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-21 10:50:47 -07:00
Miss Islington (bot) 07c3cbad95
gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93561)
(cherry picked from commit 57e8ee7086)

Co-authored-by: Davide Rizzo <sorcio@gmail.com>
2022-06-07 10:21:47 +02:00
CAM Gerlach 1df4298b62
Doc: Fix spurious comma in the author metadata field (GH-32386)
Signed-off-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-04-07 14:27:14 -04:00
Hugo van Kemenade 6881ea936e
bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124) 2022-03-30 12:00:27 +01:00
Julien Palard 6f05e1ec19
[doc] Add license_url for python-docs-theme 2022.1. (GH-30527) 2022-01-11 17:32:42 +01:00
Noah Kantrowitz be42c06bb0
Update URLs in comments and metadata to use HTTPS (GH-27458) 2021-07-30 15:54:46 +02:00
Petr Viktorin b05955d6f5
bpo-43795: PEP 652 user documentation (GH-25668)
- Reformat the C API and ABI Versioning page (and extend/clarify a bit)
- Rewrite the stable ABI docs into a general text on C API Compatibility
- Add a list of Limited API contents, and notes for the individual items. 
- Replace `Include/README.rst` with a link to a devguide page with the same info
2021-05-11 07:04:33 -07:00
Julien Palard 5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
Ammar Askar 8c5d0347ef
bpo-34398: Allow glossary results to show up on search page (GH-8773) 2020-12-18 20:00:51 +01:00
Victor Stinner 423e77d6de
bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844)
Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the
c_warn_on_allowed_pre_v3 option to make the documentation compatible
with Sphinx 2 and Sphinx 3.
2020-08-12 21:49:22 +02:00
Pablo Galindo 72cabb2aa6
bpo-40939: Use the new grammar for the grammar specification documentation (GH-19969)
(We censor the heck out of actions and some other stuff using a custom "highlighter".)

Co-authored-by: Guido van Rossum <guido@python.org>
2020-07-27 11:20:36 -07:00
Batuhan Taskaya b7a78ca74a
bpo-40517: Implement syntax highlighting support for ASDL (GH-19967) 2020-05-07 13:57:26 -07:00
Raymond Hettinger eff870b618
Revert "bpo-40517: Implement syntax highlighting support for ASDL (#19928)" (#19950)
This reverts commit d60040ba22.
2020-05-05 22:33:55 -07:00
Batuhan Taskaya d60040ba22
bpo-40517: Implement syntax highlighting support for ASDL (#19928) 2020-05-05 22:24:39 -07:00
Cheryl Sabella a4ba8a3983
Include subsections in TOC for PDF version of docs. (GH-9629) 2020-02-19 00:01:15 +01:00
Julien Palard 73e0549701 Doc: Keep the venv/* exclude pattern. (GH-15229)
In case it has been previously created.
2019-08-26 02:11:43 -04:00
Batuhan Taşkaya eab9965079 bpo-36567: Use manpages_url to create links for man pages (GH-13339) 2019-05-19 00:53:53 +03:00
Anthony Sottile a16ab00c0b bpo-36007: Bump minimum sphinx version to 1.8 (GH-11887)
https://bugs.python.org/issue36007
2019-02-15 15:41:15 -08:00