92c9c6ae14
gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347)
...
* Remove "()" when refer to a class as a type.
* Use :func: when refer to a callable.
* Fix reference to the datetime.astimezone() method.
2024-06-12 17:23:03 +03: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
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
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
96cbd1e1db
gh-101100: Fix Sphinx warnings for `fileno` ( #111118 )
2023-10-23 13:05:56 -06:00
63acf78d71
GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ( #110112 )
2023-10-19 18:05:17 +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
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
d363eb5b02
gh-107091: Fix some uses of :attr: role (GH-107318)
...
Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
f66be6b11a
gh-104773: PEP 594: Remove the audioop module ( #104937 )
2023-05-25 17:59:00 +02:00
98c4333e88
gh-104773: Remove the msilib package (GH-104911)
2023-05-24 20:06:00 -05:00
17e1fe0f9b
gh-104773: PEP 594: Remove the nis module ( #104897 )
2023-05-25 00:08:36 +02:00
684e99d01d
gh-104773: PEP 594: Remove the spwd module ( #104871 )
...
Remove spwd from the configure script and Modules/Setup.
2023-05-24 20:34:41 +00: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
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
0e72606dd4
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) ( #97774 )
2022-10-05 08:22:28 -07:00
cc9160a29b
gh-91838: Resolve more HTTP links which redirect to HTTPS (GH-95650)
2022-08-08 14:00:17 +03:00
d0d0154443
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
...
It updates links which redirect to HTTPS with different authority or
path.
2022-08-04 13:30:05 +03: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
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
877ad7b3b2
gh-92240 : Include release dates for "What's New In Python 3.X" ( #92937 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-05-28 20:24:35 -07:00
3ed1cae9ed
gh-87670: Add web.archive redirects from effbot (GH-92816)
2022-05-16 08:11:43 +02:00
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)
2018-10-31 02:26:06 +02:00
12e696b4f0
bpo-35042: Use the :pep: role where a PEP is specified ( #10036 )
2018-10-26 15:58:26 -07: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
8f1378366e
Avoid line breaks after hyphens, otherwise they are turned into spaces
2017-01-14 08:24:20 +00:00
ee1b01a41b
Issue #21818 : Fixed references to classes that have names matching with module
...
names.
2016-12-02 23:13:53 +02:00
5c67933940
Issue #26638 : Mask undefined CLI options to defeat new Sphinx warnings
2016-10-30 04:20:17 +00: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
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
0424eaf753
Marked keystrokes with the :kbd: role.
...
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
f47036c130
Removed spaces before colons and semicolons.
2013-12-24 11:04:36 +02:00
27bbcfb8ff
Merge #15543 : glossary entry for and 'universal newlines', and links to it.
...
Patch by Chris Jerdonek.
2012-08-15 11:11:27 -04:00
ee0a945ae4
#15543 : reflow paragraphs.
2012-08-15 11:05:36 -04:00
1b00f25bf9
#15543 : glossary entry for and 'universal newlines', and links to it.
...
Patch by Chris Jerdonek.
2012-08-15 10:43:58 -04:00
a2fe334081
Issue #15527 : fix docs, remove double parens by changing markup.
...
Patch by Serhiy Storchaka.
2012-08-11 21:14:08 +03:00
a6bac95a3c
issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.
2011-07-04 11:28:30 -07:00
60203b41b0
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
a5eacee237
Fix some markup glitches.
2010-07-23 16:55:26 +00:00
ad3d5c2235
Merged revisions 69803-69805,69840,69901,69905,69907,69924,69927,69987 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r69803 | georg.brandl | 2009-02-20 01:48:21 -0600 (Fri, 20 Feb 2009) | 1 line
#5327 : fix a broken link by joining it.
........
r69804 | georg.brandl | 2009-02-20 02:22:21 -0600 (Fri, 20 Feb 2009) | 1 line
At least separate imports from other statements.
........
r69805 | georg.brandl | 2009-02-20 02:45:47 -0600 (Fri, 20 Feb 2009) | 2 lines
Fix punctuation.
........
r69840 | georg.brandl | 2009-02-21 13:09:40 -0600 (Sat, 21 Feb 2009) | 1 line
#5338 , #5339 : two types in the API manual.
........
r69901 | georg.brandl | 2009-02-23 05:24:46 -0600 (Mon, 23 Feb 2009) | 2 lines
#5349 : C++ pure virtuals can also have an implementation.
........
r69905 | georg.brandl | 2009-02-23 09:51:27 -0600 (Mon, 23 Feb 2009) | 2 lines
#5352 : str.count() counts non-overlapping instances.
........
r69907 | georg.brandl | 2009-02-23 12:33:48 -0600 (Mon, 23 Feb 2009) | 1 line
Fix grammar.
........
r69924 | benjamin.peterson | 2009-02-23 20:45:35 -0600 (Mon, 23 Feb 2009) | 1 line
update README on running tests
........
r69927 | neil.schemenauer | 2009-02-23 22:23:25 -0600 (Mon, 23 Feb 2009) | 1 line
Fix call to os.waitpid, it does not take keyword args.
........
r69987 | benjamin.peterson | 2009-02-25 18:30:11 -0600 (Wed, 25 Feb 2009) | 1 line
fix str.format()'s first arg #5371
........
2009-02-26 03:38:59 +00:00
1f01debe6f
Merged revisions 68162,68166,68171,68176,68195-68196,68210,68232 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r68162 | ronald.oussoren | 2009-01-02 16:06:00 +0100 (Fri, 02 Jan 2009) | 3 lines
Fix for issue 4472 is incompatible with Cygwin, this patch
should fix that.
........
r68166 | benjamin.peterson | 2009-01-02 19:26:23 +0100 (Fri, 02 Jan 2009) | 1 line
document PyMemberDef
........
r68171 | georg.brandl | 2009-01-02 21:25:14 +0100 (Fri, 02 Jan 2009) | 3 lines
#4811 : fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina.
........
r68176 | andrew.kuchling | 2009-01-02 22:00:35 +0100 (Fri, 02 Jan 2009) | 1 line
Add various items
........
r68195 | georg.brandl | 2009-01-03 14:45:15 +0100 (Sat, 03 Jan 2009) | 2 lines
Remove useless string literal.
........
r68196 | georg.brandl | 2009-01-03 15:29:53 +0100 (Sat, 03 Jan 2009) | 2 lines
Fix indentation.
........
r68210 | georg.brandl | 2009-01-03 20:10:12 +0100 (Sat, 03 Jan 2009) | 2 lines
Set eol-style correctly for mp_distributing.py.
........
r68232 | georg.brandl | 2009-01-03 22:52:16 +0100 (Sat, 03 Jan 2009) | 2 lines
Grammar fix.
........
2009-01-03 22:47:39 +00:00
48310cd3f2
Remove trailing whitespace.
2009-01-03 21:18:54 +00:00
f10a79aad4
merge from trunk
2008-10-11 00:49:57 +00:00
0c77a82c3d
Merged revisions 63829-63831,63858,63865,63879,63882,63948,63970-63972,63976,63989,64014-64015,64021-64022,64063-64065,64067 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r63829 | mark.summerfield | 2008-05-31 15:05:34 +0200 (Sat, 31 May 2008) | 4 lines
Added a note to [] that special forms & special chars lose their meaning
and backrefs can't be used inside []
........
r63830 | georg.brandl | 2008-05-31 16:40:09 +0200 (Sat, 31 May 2008) | 2 lines
#3010 : clarification about stdin/use_rawinput.
........
r63831 | georg.brandl | 2008-05-31 16:45:55 +0200 (Sat, 31 May 2008) | 2 lines
#3005 : add explaining sentence to easydialogs docs.
........
r63858 | georg.brandl | 2008-06-01 18:41:31 +0200 (Sun, 01 Jun 2008) | 2 lines
Add plain text make target.
........
r63865 | georg.brandl | 2008-06-01 21:24:36 +0200 (Sun, 01 Jun 2008) | 2 lines
Spaces vs. tabs.
........
r63879 | gregory.p.smith | 2008-06-02 00:57:47 +0200 (Mon, 02 Jun 2008) | 3 lines
Make the _H #define's match the header file names. Fix comments to
mention the correct type names.
........
r63882 | gregory.p.smith | 2008-06-02 01:48:47 +0200 (Mon, 02 Jun 2008) | 3 lines
Adds a Thread.getIdent() method to provide the _get_ident() value for
any given threading.Thread object. feature request issue 2871.
........
r63948 | alexandre.vassalotti | 2008-06-04 22:41:44 +0200 (Wed, 04 Jun 2008) | 2 lines
Fixed complex.__getnewargs__() to not emit another complex object.
........
r63970 | andrew.kuchling | 2008-06-06 01:33:54 +0200 (Fri, 06 Jun 2008) | 1 line
Document 'utc' parameter
........
r63971 | andrew.kuchling | 2008-06-06 01:35:31 +0200 (Fri, 06 Jun 2008) | 1 line
Add various items
........
r63972 | andrew.kuchling | 2008-06-06 01:35:48 +0200 (Fri, 06 Jun 2008) | 1 line
Grammar fix
........
r63976 | georg.brandl | 2008-06-06 09:34:50 +0200 (Fri, 06 Jun 2008) | 2 lines
Markup fix.
........
r63989 | thomas.heller | 2008-06-06 20:42:11 +0200 (Fri, 06 Jun 2008) | 2 lines
Add a reminder for the maintainer of whatsnew.
........
r64014 | georg.brandl | 2008-06-07 17:59:10 +0200 (Sat, 07 Jun 2008) | 3 lines
Factor out docstring dedenting from inspect.getdoc() into inspect.cleandoc()
to ease standalone use of the algorithm.
........
r64015 | georg.brandl | 2008-06-07 18:04:01 +0200 (Sat, 07 Jun 2008) | 2 lines
Revert unwanted changes.
........
r64021 | georg.brandl | 2008-06-07 20:16:12 +0200 (Sat, 07 Jun 2008) | 2 lines
X-ref to numbers module.
........
r64022 | georg.brandl | 2008-06-07 20:17:37 +0200 (Sat, 07 Jun 2008) | 3 lines
Document the "st" API, to avoid confusion with the "new" AST.
Add a note about using the new AST module.
........
r64063 | martin.v.loewis | 2008-06-10 07:03:35 +0200 (Tue, 10 Jun 2008) | 2 lines
Add Gregor Lingl.
........
r64064 | georg.brandl | 2008-06-10 09:45:28 +0200 (Tue, 10 Jun 2008) | 2 lines
Add the "ast" module, containing helpers to ease use of the "_ast" classes.
........
r64065 | raymond.hettinger | 2008-06-10 09:57:15 +0200 (Tue, 10 Jun 2008) | 1 line
Add Arnaud for his efforts on multi-arg set operations.
........
r64067 | georg.brandl | 2008-06-10 14:46:39 +0200 (Tue, 10 Jun 2008) | 2 lines
#2536 : fix itertools.permutations and itertools.combinations docstrings.
........
2008-06-10 16:37:50 +00:00
Serhiy Storchaka
Hugo van Kemenade
Hugo van Kemenade
Adam Turner
Victor Stinner
Zachary Ware
Ned Batchelder
Oleg Iarygin
georgically
Stanley
Stéphane Wirtel
Sanyam Khurana
Martin Panter
Georg Brandl
R David Murray
Andrew Svetlov
Senthil Kumaran
Benjamin Peterson