mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-31 10:26:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
116245 commits 7 branches 633 tags 5.9 GiB
Commit graph

94 commits

Author SHA1 Message Date
Inada Naoki
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
Ashwin Ramaswami
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.

* Delete runtime.txt

* Create runtime.txt

* Delete runtime.txt

* Update netlify.toml

* Update netlify.toml

* Add netlify badge

* Update Doc/tools/templates/layout.html

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* Update layout.html

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
 2022-12-06 08:37:41 -05:00
Hugo van Kemenade
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
Victor Stinner
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
Adam Turner
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
C.A.M. Gerlach
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
CAM Gerlach
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
Zachary Ware
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
Adam Turner
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 5c1f15b4b1

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

This reverts commit b63a620014.
 2022-06-21 17:04:46 +02:00
Davide Rizzo
57e8ee7086
gh-86986: bump min sphinx version to 3.2 (GH-93337) 2022-06-07 10:05:38 +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
Jean-François B
fc8284e220 bpo-35564: add master_doc='contents' to conf.py (GH-11290) 2018-12-22 23:31:08 +01:00
Adrian Liaw
c03bf0ae79 Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423) 2018-11-04 22:04:51 +01:00
Stéphane Wirtel
859c068e52 bpo-34962: make doctest in Doc/ now passes, and is enforced in CI (GH-9806) 2018-10-12 09:51:05 +02:00
animalize
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
Jon Wayne Parrott
bf63e8d55f bpo-30607: Use external python-doc-theme (GH-2017) 2018-03-01 16:02:50 -05:00
Julien Palard
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
Ned Deily
6129250b74 Exclude non-default VENVDIR in Doc builds (#3974) 2017-10-12 16:04:57 -04:00
François Magimel
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
Marco Buttu
909a6f626f bpo-27200: Fix doctests in programming.rst and datetime.rst (#401) 2017-03-18 19:59:33 +03:00
Roger
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
Ryan Gonzalez
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
Zachary Ware
a3090a4b79 Issue #19489: Move the search box from sidebar to header and footer. 2016-09-09 13:11:27 -07:00
Senthil Kumaran
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
Senthil Kumaran
ff6c5c5466 issue27202 - Exclude 2.x release notes from python3 make doctests. 
Patch contributed by Jelle Zijlstra.
 2016-06-04 20:52:57 -07:00
Berker Peksag
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
Senthil Kumaran
cbe6356c42 Issue20969 - Set the Epub Author and Epub Publisher in Python docs. 2016-01-08 01:01:56 -08:00
Yury Selivanov
6aeda91941 docs/conf: Undo changes in b2a3baa1c2b0; issue #24400 2015-07-01 21:06:59 -04:00
Yury Selivanov
cc1d0287b5 Issue #24400: Mention that __instancecheck__ is used in abc.Awaitable and Coroutine 2015-07-01 12:49:00 -04:00
Brett Cannon
9b16666f2f Ignore .rst files in the venv directory. 2015-03-30 15:35:37 -04:00
Georg Brandl
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
Georg Brandl
e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl
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
Georg Brandl
a1f8486325 Move HTML templates to their own subdir. 2014-10-29 08:11:46 +01:00
Georg Brandl
e03902910c Move Sphinx extensions to their own subdir. 2014-10-29 08:07:37 +01:00