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
6d5b6e71c8
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
b1de3807b8
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>
2023-07-26 18:04:46 +02:00
b447e19e72
gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls ( #107062 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 22:56:56 +02:00
f8b7fe2f26
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".
2023-07-22 21:35:22 +03:00
a989b73e8e
gh-75552: Remove deprecated tkinter.tix module (GH-104902)
2023-05-27 12:34:19 -05:00
35d273825a
GH-97950: Allow translation of index directive content ( #104000 )
2023-05-04 10:11:09 +03:00
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
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
79ae019164
gh-101100: Fix Sphinx warnings in `argparse` module ( #103289 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 15:36:32 -06:00
caed49448d
GH-103484: Fix broken links reported by linkcheck ( #103608 )
...
* Doc: Fix broken links reported by linkcheck
* Apply suggestions from code review
- Remove extra diff line in faq/library.rst (merwok)
- Use HTTPS to link Unicode 15.0.0 to solve a redirect (hugovk)
- Use wayback machine link for openssl 1.1.0 instead of linking 1.1.1, "as this text mentions a feature from 1.1.0" (hugovk)
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Doc: Make mark-up code as literal
* Doc: Alphabetize items in linkcheck_ignore
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Doc: Improve comment in sphinx conf
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
---------
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>
2023-04-22 08:24:47 -06:00
f39e00f952
GH-103484: Docs: add linkcheck allowed redirects entries for most cases ( #103569 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-18 05:57:53 +03:00
280bd536b5
Docs: don't render files in includes/, they're for embedding only ( #103313 )
2023-04-11 09:17:34 +03:00
7d1d663418
Doc: Fix minor error in ePub (GH-100614)
...
Fix issue reported https://mail.python.org/archives/list/docs@python.org/message/KE7OIAO53P4XRC4ZOWPDHA63ZQJCHEC3/
2023-03-01 09:48:15 +09:00
85d5a7e8ef
bpo-37860: re-add netlify.toml to set up deploy previews for docs ( #92852 )
...
* Revert "bpo-46184: remove `netlify.toml` (#30272 )"
This reverts commit fbaf2e604c
2022-12-06 08:37:41 -05:00
f49c735e52
Use sphinxext-opengraph to generate OpenGraph metadata ( #99931 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-05 23:26:28 +02:00
0faa0ba240
gh-92584: Remove the distutils package ( #99061 )
...
Remove the distutils package. It was deprecated in Python 3.10 by PEP
632 "Deprecate distutils module". For projects still using distutils
and cannot be updated to something else, the setuptools project can
be installed: it still provides distutils.
* Remove Lib/distutils/ directory
* Remove test_distutils
* Remove references to distutils
* Skip test_check_c_globals and test_peg_generator since they use
distutils
2022-11-03 19:27:27 +01:00
f612565bd3
gh-93738: Disallow pre-v3 syntax in the C domain ( #97962 )
...
Also, disable using invalid sphinx-lint 0.6.2.
2022-10-06 10:11:37 -07:00
9148c0d893
gh-97740: Fix bang in Sphinx C domain ref target syntax ( #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>
2022-10-03 05:51:22 +02:00
ac3bf6155f
gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message (GH-95607)
2022-08-03 20:23:20 +01:00
82814624bf
Doctest cleanups (GH-95436)
...
* GHA: Don't hide doctest output
* Enable doctests in math.rst
* Squash warnings in nntplib.rst doctests
* Squash warning in turtle.rst doctest
* Squash warnings in whatsnew/3.2.rst doctests
* Treat warnings as errors in Doc/ doctests
2022-07-30 17:21:08 -05:00
0efe3a1636
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 5c1f15b4b1b63a620014
2022-06-21 17:04:46 +02:00
57e8ee7086
gh-86986: bump min sphinx version to 3.2 (GH-93337)
2022-06-07 10:05:38 +02:00
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
6881ea936e
bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)
2022-03-30 12:00:27 +01:00
6f05e1ec19
[doc] Add license_url for python-docs-theme 2022.1. (GH-30527)
2022-01-11 17:32:42 +01:00
be42c06bb0
Update URLs in comments and metadata to use HTTPS (GH-27458)
2021-07-30 15:54:46 +02:00
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
5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)
2021-01-25 15:46:06 +01:00
8c5d0347ef
bpo-34398: Allow glossary results to show up on search page (GH-8773)
2020-12-18 20:00:51 +01:00
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
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
b7a78ca74a
bpo-40517: Implement syntax highlighting support for ASDL (GH-19967)
2020-05-07 13:57:26 -07:00
eff870b618
Revert "bpo-40517: Implement syntax highlighting support for ASDL ( #19928 )" ( #19950 )
...
This reverts commit d60040ba22
2020-05-05 22:33:55 -07:00
d60040ba22
bpo-40517: Implement syntax highlighting support for ASDL ( #19928 )
2020-05-05 22:24:39 -07:00
a4ba8a3983
Include subsections in TOC for PDF version of docs. (GH-9629)
2020-02-19 00:01:15 +01:00
73e0549701
Doc: Keep the venv/* exclude pattern. (GH-15229)
...
In case it has been previously created.
2019-08-26 02:11:43 -04:00
eab9965079
bpo-36567: Use manpages_url to create links for man pages (GH-13339)
2019-05-19 00:53:53 +03:00
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
fc8284e220
bpo-35564: add master_doc='contents' to conf.py (GH-11290)
2018-12-22 23:31:08 +01:00
c03bf0ae79
Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423)
2018-11-04 22:04:51 +01:00
859c068e52
bpo-34962: make doctest in Doc/ now passes, and is enforced in CI (GH-9806)
2018-10-12 09:51:05 +02:00
6261ae9b01
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
...
Let .chm document display non-ASCII characters properly
Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
2018-10-08 14:20:54 -07:00
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
7324b5ce8e
bpo-31589 : Build PDF using xelatex for better UTF8 support. ( #3940 )
...
Also addresses doc build failures documented in bpo-32200.
2017-12-02 17:24:39 -05:00
6129250b74
Exclude non-default VENVDIR in Doc builds ( #3974 )
2017-10-12 16:04:57 -04:00
da9b4cfb48
bpo-31423: Fix building the PDF documentation (GH-3693)
...
Use prefixed macro names for the `authoraddress` function, add T2A to the font encoding in LaTeX sources to support Cyrillic characters in the PDF documentation, and replace the deprecated `font_size` config option with `pointsize`.
2017-09-22 12:16:57 -05:00
909a6f626f
bpo-27200: Fix doctests in programming.rst and datetime.rst ( #401 )
2017-03-18 19:59:33 +03:00
b3f1f59cf4
Rename Doc/README.txt to Doc/README.rst and add formatting ( #104 )
...
* Reformat Doc/README.txt to Doc/README.rst
* Update mention of Doc/README.rst
* Update mention of README.txt to README.rst
* Make line fold
* rstlint ignore Doc/README.rst
* conf.py ignore Doc/README.rst
* Update issue tracker url in Docs/README.rst
2017-02-15 23:54:05 +01:00
e7ffb99f84
Fix some sphinx warnings ( #9 )
...
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
2017-02-11 13:47:37 +09:00
a3090a4b79
Issue #19489 : Move the search box from sidebar to header and footer.
2016-09-09 13:11:27 -07:00
889f914edb
issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6)
...
exclude_patterns in Sphinx conf.py will exclude the .rsts from the build. It
was incorrect exclude 2.x rsts in that. This fix contributed again Jelle
Zijlstra, excludes doctests in whatsnew/2.7.rst from being exercised by using
doctests skip option.
2016-06-04 22:22:26 -07:00
ff6c5c5466
issue27202 - Exclude 2.x release notes from python3 make doctests.
...
Patch contributed by Jelle Zijlstra.
2016-06-04 20:52:57 -07:00
2ec1bee1b3
Issue #19731 : Update copyright year in docs.p.o footer
...
See https://mail.python.org/pipermail/python-legal-sig/2013-November/000059.html
for details.
Patch by Antoine Pitrou.
2016-04-24 03:21:13 +03:00
cbe6356c42
Issue20969 - Set the Epub Author and Epub Publisher in Python docs.
2016-01-08 01:01:56 -08:00
6aeda91941
docs/conf: Undo changes in b2a3baa1c2b0; issue #24400
2015-07-01 21:06:59 -04:00
cc1d0287b5
Issue #24400 : Mention that __instancecheck__ is used in abc.Awaitable and Coroutine
2015-07-01 12:49:00 -04:00
9b16666f2f
Ignore .rst files in the venv directory.
2015-03-30 15:35:37 -04:00
0ef496678a
linkcheck: ignore issue URLs and PEP URLs (the latter until the PEPs are on www.python.org again).
2014-10-29 10:57:01 +01:00
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
9ab33eada4
Adjust the author field of the .tex files to reflect that docs are now maintained by all of us
2014-10-29 08:14:04 +01:00
a1f8486325
Move HTML templates to their own subdir.
2014-10-29 08:11:46 +01:00
e03902910c
Move Sphinx extensions to their own subdir.
2014-10-29 08:07:37 +01:00
9a333a6f65
Remove a few config values that keep the default values, move values to the correct section
2014-10-29 08:04:27 +01:00
3fdea95307
Remove deprecated and now unnecessary config value from conf.py.
2014-10-29 07:58:34 +01:00
ea7ec2b481
Remove unused and now removed config value.
2014-10-02 08:27:05 +02:00
14366f3a8e
Fix overlooked conf.py setting in flattening of Doc directory.
2014-09-30 18:41:37 -07:00
97e9ec688c
Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore.
2014-09-30 22:51:30 +02:00
90d76ca765
Closes #21431 : make docs depend on Sphinx 1.2 and fix pydoc-topics builder to
...
return Unicode strings on Python 3.
2014-09-22 21:18:24 +02:00
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
5c01d99c12
Introduce support for documenting which C API elements are not part of the stable/limited API.
2013-10-12 19:54:30 +02:00
014397e981
Determine opensearch URL from current version.
2012-04-07 19:24:40 +02:00
30e4ca45ad
Closes #14511 : merge with 3.2
2012-04-07 19:23:00 +02:00
3abebca780
Closes #14511 : fix wrong opensearch link for 3.2 docs.
2012-04-07 19:22:17 +02:00
ab7121430e
Switch to new "lighter" doc design.
2012-03-25 20:31:57 +02:00
c77bb65deb
Remove "documenting" latex document.
2012-01-16 21:40:12 +01:00
e5b5ff4961
Build a PDF of the FAQs too.
2010-11-12 06:19:48 +00:00
e8f583244a
Issue #9308 : Removed redundant coding cookies. Added tests for
...
importing encoded modules that do not depend on specific stdlib
modules being encoded in a certain way.
2010-10-15 16:28:20 +00:00
8d58216050
More inclusive title.
2010-09-03 22:33:27 +00:00
9707fd2ec0
More descriptive title.
2010-09-01 08:57:16 +00:00
a074523f3a
#3143 : enable "collapsible sidebar" feature of new Sphinx version.
2010-07-30 11:31:03 +00:00
4bf70686fa
Update Sphinx to 1.0.1.
2010-07-27 18:19:21 +00:00
da18125ae1
more stable url
2009-10-01 00:57:32 +00:00
51e491000d
fix opensearch version
2009-10-01 00:10:13 +00:00
Hugo van Kemenade