Commit Graph

92 Commits

Author SHA1 Message Date
Hugo van Kemenade 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
Adam Turner 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
Serhiy Storchaka 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
Christian Heimes 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
Ned Batchelder 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
Oleg Iarygin f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853) 2022-06-21 20:55:18 +02:00
Stanley 3ed1cae9ed
gh-87670: Add web.archive redirects from effbot (GH-92816) 2022-05-16 08:11:43 +02: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
Serhiy Storchaka 4f05f15d7b
[docs] Improve the markup of powers (GH-28598) 2021-09-28 22:40:57 +02:00
Serhiy Storchaka e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
Also fix some other formatting.
2019-10-30 21:37:16 +02:00
Serhiy Storchaka 2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Ned Deily 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
Stéphane Wirtel 19177fbd5d bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) 2018-05-15 14:58:35 -04:00
Sanyam Khurana 338cd83c5d bpo-25910: Link redirections in docs (#1933)
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01:00
Serhiy Storchaka c7b1a0bbe2 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:28 +02:00
Martin Panter 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
Martin Panter 5c67933940 Issue #26638: Mask undefined CLI options to defeat new Sphinx warnings 2016-10-30 04:20:17 +00:00
Serhiy Storchaka 4adf01caae Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:05 +03:00
Martin Panter d210a70dd9 Minor spelling fixes 2016-08-20 08:03:06 +00:00
Martin Panter 1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02: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
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Martin Panter 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
Serhiy Storchaka de886d9233 Issue #25910: Fixed more links in the docs. 2016-04-11 17:32:33 +03:00
Georg Brandl 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
Serhiy Storchaka d65c9496da Issue #25523: Further a-to-an corrections. 2015-11-02 14:10:23 +02:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Benjamin Peterson cbfaa7b9d3 standardize pep 466 relnote style 2014-09-19 17:27:03 -04:00
Benjamin Peterson 49d77fd58a remove extra letter 2014-09-19 17:29:08 -04:00
Benjamin Peterson ce30237493 whatsnew for pep 466 ssl backport 2014-09-19 17:23:21 -04:00
Serhiy Storchaka 148679982f Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:43:41 +03:00
Nick Coghlan a5bbc2ea3d Forward port PEP 466 What's New in 2.7 updates 2014-08-23 14:47:47 +10:00
Nick Coghlan b1f59cecc9 Issue #21569: Fix incorrect cross reference 2014-06-09 13:14:54 +10:00
Nick Coghlan 024b2f52bf Issue #21569: sync Python 2.7 What's New with 2.7 version 2014-06-07 23:43:00 +10:00
Georg Brandl 75f0020d29 Remove confusing "Release" and "Date" markers from whatsnews. 2012-10-28 13:35:56 +01:00
Antoine Pitrou fbd4f80979 Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
Ezio Melotti 4e15828640 Fix/improve markup in whatsnew/2.7. 2011-10-10 00:30:14 +03:00
Senthil Kumaran a3b2316a1b merge from 2.7 - Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902. 2011-08-06 12:54:23 +08:00
Georg Brandl 8449932320 #10526: fix typo. 2010-11-26 11:50:13 +00:00
Georg Brandl 60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00
Mark Dickinson 8858d2cb84 Clarify whatsnew entry for short float repr: roundtripping is not a new feature in 2.7. 2010-08-15 09:43:29 +00:00
Georg Brandl de41bf3dd5 Fix typo. 2010-07-11 09:26:57 +00:00
Georg Brandl b0f0991cdb #9166: NotImplemented is not an exception. 2010-07-05 17:48:38 +00:00
Nick Coghlan 4bfb7da842 Merged revisions 82441 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r82441 | nick.coghlan | 2010-07-03 02:01:53 +1000 (Sat, 03 Jul 2010) | 1 line

  Issue 8202 actually caused an unintended behavioural change and was reverted in 2.7 - remove reference from What's New
........
2010-07-02 16:14:05 +00:00
Nick Coghlan 9fc68c4e70 Merged revisions 82439 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r82439 | nick.coghlan | 2010-07-03 01:50:14 +1000 (Sat, 03 Jul 2010) | 1 line

  Fix a couple of minor nits in What's New before the release goes out
........
2010-07-02 15:57:50 +00:00
Benjamin Peterson d7c3ed54ef Merged revisions 80605-80609,80642-80646,80651-80652,80674,80684-80686,80748,80852,80854,80870,80872-80873,80907,80915-80916,80951-80952,80976-80977,80985,81038-81040,81042,81053,81070,81104-81105,81114,81125,81245,81285,81402,81463,81516,81562-81563,81567,81593,81635,81680-81681,81684,81801,81888,81931-81933,81939-81942,81963,81984,81991,82120,82188,82264-82267 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r80605 | andrew.kuchling | 2010-04-28 19:22:16 -0500 (Wed, 28 Apr 2010) | 1 line

  Add various items
........
  r80606 | andrew.kuchling | 2010-04-28 20:44:30 -0500 (Wed, 28 Apr 2010) | 6 lines

  Fix doubled 'the'.
  Markup fixes to use :exc:, :option: in a few places.
    (Glitch: unittest.main's -c ends up a link to the Python
    interpreter's -c option.  Should we skip using :option: for that
    switch, or disable the auto-linking somehow?)
........
  r80607 | andrew.kuchling | 2010-04-28 20:45:41 -0500 (Wed, 28 Apr 2010) | 1 line

  Add various unittest items
........
  r80608 | benjamin.peterson | 2010-04-28 22:18:05 -0500 (Wed, 28 Apr 2010) | 1 line

  update pypy description
........
  r80609 | benjamin.peterson | 2010-04-28 22:30:59 -0500 (Wed, 28 Apr 2010) | 1 line

  update pypy url
........
  r80642 | andrew.kuchling | 2010-04-29 19:49:09 -0500 (Thu, 29 Apr 2010) | 1 line

  Always add space after RFC; reword paragraph
........
  r80643 | andrew.kuchling | 2010-04-29 19:52:31 -0500 (Thu, 29 Apr 2010) | 6 lines

  Reword paragraph to make its meaning clearer.

  Antoine Pitrou: is my version of the paragraph still correct?

  R. David Murray: is this more understandable than the previous version?
........
  r80644 | andrew.kuchling | 2010-04-29 20:02:15 -0500 (Thu, 29 Apr 2010) | 1 line

  Fix typos
........
  r80645 | andrew.kuchling | 2010-04-29 20:32:47 -0500 (Thu, 29 Apr 2010) | 1 line

  Markup fix; clarify by adding 'in that order'
........
  r80646 | andrew.kuchling | 2010-04-29 20:33:40 -0500 (Thu, 29 Apr 2010) | 1 line

  Add various items; rearrange unittest section a bit
........
  r80651 | andrew.kuchling | 2010-04-30 08:46:55 -0500 (Fri, 30 Apr 2010) | 1 line

  Minor grammar re-wording
........
  r80652 | andrew.kuchling | 2010-04-30 08:47:34 -0500 (Fri, 30 Apr 2010) | 1 line

  Add item
........
  r80674 | andrew.kuchling | 2010-04-30 20:19:16 -0500 (Fri, 30 Apr 2010) | 1 line

  Add various items
........
  r80684 | andrew.kuchling | 2010-05-01 07:05:52 -0500 (Sat, 01 May 2010) | 1 line

  Minor grammar fix
........
  r80685 | andrew.kuchling | 2010-05-01 07:06:51 -0500 (Sat, 01 May 2010) | 1 line

  Describe memoryview
........
  r80686 | antoine.pitrou | 2010-05-01 07:16:39 -0500 (Sat, 01 May 2010) | 4 lines

  Fix attribution. Travis didn't do much and he did a bad work.
  (yes, this is a sensitive subject, sorry)
........
  r80748 | andrew.kuchling | 2010-05-03 20:24:22 -0500 (Mon, 03 May 2010) | 1 line

  Add some more items; the urlparse change is added twice
........
  r80852 | andrew.kuchling | 2010-05-05 20:09:47 -0500 (Wed, 05 May 2010) | 1 line

  Reword paragraph; fix filename, which should be pyconfig.h
........
  r80854 | andrew.kuchling | 2010-05-05 20:10:56 -0500 (Wed, 05 May 2010) | 1 line

  Add various items
........
  r80870 | andrew.kuchling | 2010-05-06 09:14:09 -0500 (Thu, 06 May 2010) | 1 line

  Describe ElementTree 1.3; rearrange new-module sections; describe dict views as sets; small edits and items
........
  r80872 | andrew.kuchling | 2010-05-06 12:21:59 -0500 (Thu, 06 May 2010) | 1 line

  Add 2 items; record ideas for two initial sections; clarify wording
........
  r80873 | andrew.kuchling | 2010-05-06 12:27:57 -0500 (Thu, 06 May 2010) | 1 line

  Change section title; point to unittest2
........
  r80907 | andrew.kuchling | 2010-05-06 20:45:14 -0500 (Thu, 06 May 2010) | 1 line

  Add a new section on the development plan; add an item
........
  r80915 | antoine.pitrou | 2010-05-07 05:15:51 -0500 (Fri, 07 May 2010) | 3 lines

  Fix some markup and a class name. Also, wrap a long line.
........
  r80916 | andrew.kuchling | 2010-05-07 06:30:47 -0500 (Fri, 07 May 2010) | 1 line

  Re-word text
........
  r80951 | andrew.kuchling | 2010-05-07 20:15:26 -0500 (Fri, 07 May 2010) | 1 line

  Add two items
........
  r80952 | andrew.kuchling | 2010-05-07 20:35:55 -0500 (Fri, 07 May 2010) | 1 line

  Get accents correct
........
  r80976 | andrew.kuchling | 2010-05-08 08:28:03 -0500 (Sat, 08 May 2010) | 1 line

  Add logging.dictConfig example; give up on writing a Ttk example
........
  r80977 | andrew.kuchling | 2010-05-08 08:29:46 -0500 (Sat, 08 May 2010) | 1 line

  Markup fixes
........
  r80985 | andrew.kuchling | 2010-05-08 10:39:46 -0500 (Sat, 08 May 2010) | 7 lines

  Write summary of the 2.7 release; rewrite the future section some more;
  mention PYTHONWARNINGS env. var; tweak some examples for readability.

  And with this commit, the "What's New" is done... except for a
  complete read-through to polish the text, and fixing any reported errors,
  but those tasks can easily wait until after beta2.
........
  r81038 | benjamin.peterson | 2010-05-09 16:09:40 -0500 (Sun, 09 May 2010) | 1 line

  finish clause
........
  r81039 | andrew.kuchling | 2010-05-10 09:18:27 -0500 (Mon, 10 May 2010) | 1 line

  Markup fix; re-word a sentence
........
  r81040 | andrew.kuchling | 2010-05-10 09:20:12 -0500 (Mon, 10 May 2010) | 1 line

  Use title case
........
  r81042 | andrew.kuchling | 2010-05-10 10:03:35 -0500 (Mon, 10 May 2010) | 1 line

  Link to unittest2 article
........
  r81053 | florent.xicluna | 2010-05-10 14:59:22 -0500 (Mon, 10 May 2010) | 2 lines

  Add a link on maketrans().
........
  r81070 | andrew.kuchling | 2010-05-10 18:13:41 -0500 (Mon, 10 May 2010) | 1 line

  Fix typo
........
  r81104 | andrew.kuchling | 2010-05-11 19:38:44 -0500 (Tue, 11 May 2010) | 1 line

  Revision pass: lots of edits, typo fixes, rearrangements
........
  r81105 | andrew.kuchling | 2010-05-11 19:40:47 -0500 (Tue, 11 May 2010) | 1 line

  Let's call this done
........
  r81114 | andrew.kuchling | 2010-05-12 08:56:07 -0500 (Wed, 12 May 2010) | 1 line

  Grammar fix
........
  r81125 | andrew.kuchling | 2010-05-12 13:56:48 -0500 (Wed, 12 May 2010) | 1 line

  #8696: add documentation for logging.config.dictConfig (PEP 391)
........
  r81245 | andrew.kuchling | 2010-05-16 18:31:16 -0500 (Sun, 16 May 2010) | 1 line

  Add cross-reference to later section
........
  r81285 | vinay.sajip | 2010-05-18 03:16:27 -0500 (Tue, 18 May 2010) | 1 line

  Fixed minor typo in ReST markup.
........
  r81402 | vinay.sajip | 2010-05-21 12:41:34 -0500 (Fri, 21 May 2010) | 1 line

  Updated logging documentation with more dictConfig information.
........
  r81463 | georg.brandl | 2010-05-22 03:17:23 -0500 (Sat, 22 May 2010) | 1 line

  #8785: less confusing description of regex.find*.
........
  r81516 | andrew.kuchling | 2010-05-25 08:34:08 -0500 (Tue, 25 May 2010) | 1 line

  Add three items
........
  r81562 | andrew.kuchling | 2010-05-27 08:22:53 -0500 (Thu, 27 May 2010) | 1 line

  Rewrite wxWidgets section
........
  r81563 | andrew.kuchling | 2010-05-27 08:30:09 -0500 (Thu, 27 May 2010) | 1 line

  Remove top-level 'General Questions' section, pushing up the questions it contains
........
  r81567 | andrew.kuchling | 2010-05-27 16:29:59 -0500 (Thu, 27 May 2010) | 1 line

  Add item
........
  r81593 | georg.brandl | 2010-05-29 03:46:18 -0500 (Sat, 29 May 2010) | 1 line

  #8616: add new turtle demo "nim".
........
  r81635 | georg.brandl | 2010-06-01 02:25:23 -0500 (Tue, 01 Jun 2010) | 1 line

  Put docs for RegexObject.search() before RegexObject.match() to mirror re.search() and re.match() order.
........
  r81680 | vinay.sajip | 2010-06-03 17:34:42 -0500 (Thu, 03 Jun 2010) | 1 line

  Issue #8890: Documentation changed to avoid reference to temporary files.
........
  r81681 | sean.reifschneider | 2010-06-03 20:51:26 -0500 (Thu, 03 Jun 2010) | 2 lines

  Issue8810: Clearing up docstring for tzinfo.utcoffset.
........
  r81684 | vinay.sajip | 2010-06-04 08:41:02 -0500 (Fri, 04 Jun 2010) | 1 line

  Issue #8890: Documentation changed to avoid reference to temporary files - other cases covered.
........
  r81801 | andrew.kuchling | 2010-06-07 08:38:40 -0500 (Mon, 07 Jun 2010) | 1 line

  #8875: Remove duplicated paragraph
........
  r81888 | andrew.kuchling | 2010-06-10 20:54:58 -0500 (Thu, 10 Jun 2010) | 1 line

  Add a few more items
........
  r81931 | georg.brandl | 2010-06-12 01:26:54 -0500 (Sat, 12 Jun 2010) | 1 line

  Fix punctuation.
........
  r81932 | georg.brandl | 2010-06-12 01:28:58 -0500 (Sat, 12 Jun 2010) | 1 line

  Document that an existing directory raises in mkdir().
........
  r81933 | georg.brandl | 2010-06-12 01:45:33 -0500 (Sat, 12 Jun 2010) | 1 line

  Update version in README.
........
  r81939 | georg.brandl | 2010-06-12 04:45:01 -0500 (Sat, 12 Jun 2010) | 1 line

  Use newer toctree syntax.
........
  r81940 | georg.brandl | 2010-06-12 04:45:28 -0500 (Sat, 12 Jun 2010) | 1 line

  Add document on how to build.
........
  r81941 | georg.brandl | 2010-06-12 04:45:58 -0500 (Sat, 12 Jun 2010) | 1 line

  Fix gratuitous indentation.
........
  r81942 | georg.brandl | 2010-06-12 04:46:03 -0500 (Sat, 12 Jun 2010) | 1 line

  Update README.
........
  r81963 | andrew.kuchling | 2010-06-12 15:00:55 -0500 (Sat, 12 Jun 2010) | 1 line

  Grammar fix
........
  r81984 | georg.brandl | 2010-06-14 10:58:39 -0500 (Mon, 14 Jun 2010) | 1 line

  #8993: fix reference.
........
  r81991 | andrew.kuchling | 2010-06-14 19:38:58 -0500 (Mon, 14 Jun 2010) | 1 line

  Add another bunch of items
........
  r82120 | andrew.kuchling | 2010-06-20 16:45:45 -0500 (Sun, 20 Jun 2010) | 1 line

  Note that Python 3.x isn't covered; add forward ref. for UTF-8; note error in 2.5 and up
........
  r82188 | benjamin.peterson | 2010-06-23 19:02:46 -0500 (Wed, 23 Jun 2010) | 1 line

  remove reverted changed
........
  r82264 | georg.brandl | 2010-06-27 05:47:47 -0500 (Sun, 27 Jun 2010) | 1 line

  Confusing punctuation.
........
  r82265 | georg.brandl | 2010-06-27 05:49:23 -0500 (Sun, 27 Jun 2010) | 1 line

  Use designated syntax for optional grammar element.
........
  r82266 | georg.brandl | 2010-06-27 05:51:44 -0500 (Sun, 27 Jun 2010) | 1 line

  Fix URL.
........
  r82267 | georg.brandl | 2010-06-27 05:55:38 -0500 (Sun, 27 Jun 2010) | 1 line

  Two typos.
........
2010-06-27 22:32:30 +00:00
Ezio Melotti 11d22dce3a Merged revisions 79963,80024,80064,80070,80085,80088 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r79963 | andrew.kuchling | 2010-04-11 23:40:09 +0300 (Sun, 11 Apr 2010) | 1 line

  Add several items
........
  r80024 | andrew.kuchling | 2010-04-13 04:32:51 +0300 (Tue, 13 Apr 2010) | 1 line

  Add an item; stray edit
........
  r80064 | andrew.kuchling | 2010-04-14 04:14:59 +0300 (Wed, 14 Apr 2010) | 1 line

  Add argparse example
........
  r80070 | andrew.kuchling | 2010-04-14 17:28:31 +0300 (Wed, 14 Apr 2010) | 1 line

  Add some text
........
  r80085 | andrew.kuchling | 2010-04-15 02:55:17 +0300 (Thu, 15 Apr 2010) | 1 line

  Add various items; correct argparse output
........
  r80088 | andrew.kuchling | 2010-04-15 04:42:27 +0300 (Thu, 15 Apr 2010) | 1 line

  Add various items
........
2010-04-20 09:55:05 +00:00