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
dbe44f150c
Docs: mark up NotImplemented using the :data: role throughout the docs ( #116135 )
2024-02-29 20:46:12 +00:00
92483b21b3
gh-101100: Fix Sphinx warnings in `whatsnew/2.7.rst` and related ( #115319 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-12 14:40:41 +02:00
848c86786b
gh-101100: Fix Sphinx warnings from PEP 3108 stdlib re-organisation ( #114327 )
...
* Fix Sphinx warnings from PEP 3108 stdblib re-organisation
* Apply suggestions from code review
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Update Doc/whatsnew/2.2.rst
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Apply suggestions from code review
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---------
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-04 09:45:35 +00:00
b6623d61d4
gh-101100: Fix Sphinx warnings in `whatsnew/3.11.rst` and related ( #114531 )
2024-01-27 06:06:59 -07:00
a8629816c6
gh-113664: Improve style of Big O notation (GH-113695)
...
Use cursive to make it looking like mathematic formulas.
2024-01-10 15:01:18 +02:00
e56c53334f
gh-101100: Fix Sphinx warnings for 2.6 deprecations and removals ( #113725 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-05 13:31:28 +00:00
30a6d79fb8
gh-101100: Fix Sphinx warnings in `library/configparser.rst` ( #113598 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-31 10:57:33 -07:00
3531ea441b
gh-101100: Fix Sphinx warning in references with asterisks ( #113029 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-13 09:24:55 +02:00
ed21d0c1f4
gh-101100: Improve documentation for attributes on instance methods ( #112832 )
2023-12-08 13:18:53 +00:00
e9707d3c3d
gh-101100: Improve documentation of code object attributes ( #112781 )
2023-12-06 20:15:46 +00:00
45650d1c47
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` ( #112662 )
2023-12-03 17:32:49 +00:00
ffe1b2d07b
GH-101100: Fix reference warnings for ``socket`` methods ( #110114 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-11-27 16:36:54 +02:00
63acf78d71
GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ( #110112 )
2023-10-19 18:05:17 +03:00
3dd593e2f2
gh-110631: fix wrong indentation in the `Doc/whatsnew` dir ( #110632 )
...
Fix wrong indentation in the Doc/whatsnew dir.
2023-10-11 07:34:38 +02:00
422f81b5d2
gh-107298: Fix a few more refs in the C API docs (GH-108361)
...
gh-107298: Fix few more refs in the C API docs
2023-08-23 20:12:42 +03:00
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
f51f0466c0
gh-107298: Fix some references in the C API documentation (GH-108072)
2023-08-17 11:16:00 +03: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
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
ded5f1f287
gh-104773: PEP 594: Remove the nntplib module ( #104894 )
...
* socket_helper.transient_internet() no longer imports nntplib to
catch nntplib.NNTPTemporaryError.
* ssltests.py no longer runs test_nntplib.
* "make quicktest" no longer runs test_nntplib.
* WASM: remove nntplib from OMIT_NETWORKING_FILES.
* Remove mentions to nntplib in the email documentation.
2023-05-24 21:15:43 +00: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
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
0031e62973
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) ( #97768 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-05 11:01:14 -07:00
f79547a429
gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527)
...
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.
This change does not affect Python examples.
2022-08-04 10:13:49 +03:00
a566912049
gh-85454: Remove distutils documentation ( #95239 )
...
Most places now refer to setuptools or link to setuptools documentation.
Some examples like zipapp need to be updated later.
2022-07-25 15:50:46 +02:00
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
2022-07-05 11:16:10 +02:00
f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853)
2022-06-21 20:55:18 +02:00
3ed1cae9ed
gh-87670: Add web.archive redirects from effbot (GH-92816)
2022-05-16 08:11:43 +02:00
6881ea936e
bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)
2022-03-30 12:00:27 +01:00
4f05f15d7b
[docs] Improve the markup of powers (GH-28598)
2021-09-28 22:40:57 +02:00
e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
...
Also fix some other formatting.
2019-10-30 21:37:16 +02:00
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
9d6171ded5
bpo-23404: Update/sync What's New files for 3.6/3.5/2.7 (GH-7620)
2018-06-11 04:09:34 -04:00
19177fbd5d
bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814)
2018-05-15 14:58:35 -04:00
338cd83c5d
bpo-25910: Link redirections in docs ( #1933 )
...
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
1b4587a246
bpo-25910: Fixes redirection from http to https ( #4674 )
2017-12-06 17:39:33 +01:00
c7b1a0bbe2
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:43:28 +02:00
b8c5f54248
Issue #26638 : Work around more CLI options that can’t be linked
...
* Cannot seem to link directly to main options from the “unittest” module,
because that module has its own set of options
* Mask out linking for options that no longer exist in Python 3
2016-10-30 04:20:23 +00:00
5c67933940
Issue #26638 : Mask undefined CLI options to defeat new Sphinx warnings
2016-10-30 04:20:17 +00:00
4adf01caae
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:05 +03:00
d210a70dd9
Minor spelling fixes
2016-08-20 08:03:06 +00:00
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02: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
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
00ccacc8db
Issue #26638 : Fix links to some CLI options and section headings
...
* Disable inappropriate links to Python interpreter options
* Correct link to CLI section in zipapp
* Make CLI section label in timeit less ambiguous
2016-04-16 04:59:38 +00:00
de886d9233
Issue #25910 : Fixed more links in the docs.
2016-04-11 17:32:33 +03:00
5d94134040
Closes #25910 : fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch.
2016-02-26 19:37:12 +01:00
Hugo van Kemenade
Erlend E. Aasland
Serhiy Storchaka
Hugo van Kemenade
Alex Waygood
Adam Turner
Ezio Melotti
Victor Stinner
Rafael Fontenelle
Stanley
Christian Heimes
Ned Batchelder
Oleg Iarygin
Ned Deily
Stéphane Wirtel
Sanyam Khurana
Martin Panter
Senthil Kumaran
Georg Brandl