Commit d97b7dc9 authored by Serhiy Storchaka's avatar Serhiy Storchaka Committed by GitHub

bpo-30380: Fix Sphinx 1.6.1 warnings. (#1613)

* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS.
parent af34e0a0
...@@ -34,8 +34,8 @@ handling common situations - like basic authentication, cookies, proxies and so ...@@ -34,8 +34,8 @@ handling common situations - like basic authentication, cookies, proxies and so
on. These are provided by objects called handlers and openers. on. These are provided by objects called handlers and openers.
urllib.request supports fetching URLs for many "URL schemes" (identified by the string urllib.request supports fetching URLs for many "URL schemes" (identified by the string
before the ":" in URL - for example "ftp" is the URL scheme of before the ``":"`` in URL - for example ``"ftp"`` is the URL scheme of
"ftp://python.org/") using their associated network protocols (e.g. FTP, HTTP). ``"ftp://python.org/"``) using their associated network protocols (e.g. FTP, HTTP).
This tutorial focuses on the most common case, HTTP. This tutorial focuses on the most common case, HTTP.
For straightforward situations *urlopen* is very easy to use. But as soon as you For straightforward situations *urlopen* is very easy to use. But as soon as you
...@@ -511,10 +511,10 @@ than the URL you pass to .add_password() will also match. :: ...@@ -511,10 +511,10 @@ than the URL you pass to .add_password() will also match. ::
``top_level_url`` is in fact *either* a full URL (including the 'http:' scheme ``top_level_url`` is in fact *either* a full URL (including the 'http:' scheme
component and the hostname and optionally the port number) component and the hostname and optionally the port number)
e.g. "http://example.com/" *or* an "authority" (i.e. the hostname, e.g. ``"http://example.com/"`` *or* an "authority" (i.e. the hostname,
optionally including the port number) e.g. "example.com" or "example.com:8080" optionally including the port number) e.g. ``"example.com"`` or ``"example.com:8080"``
(the latter example includes a port number). The authority, if present, must (the latter example includes a port number). The authority, if present, must
NOT contain the "userinfo" component - for example "joe:password@example.com" is NOT contain the "userinfo" component - for example ``"joe:password@example.com"`` is
not correct. not correct.
......
...@@ -869,7 +869,7 @@ The ``errors`` module has the following attributes: ...@@ -869,7 +869,7 @@ The ``errors`` module has the following attributes:
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#] The encoding string included in XML output should conform to the .. [1] The encoding string included in XML output should conform to the
appropriate standards. For example, "UTF-8" is valid, but "UTF8" is appropriate standards. For example, "UTF-8" is valid, but "UTF8" is
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
and https://www.iana.org/assignments/character-sets/character-sets.xhtml. and https://www.iana.org/assignments/character-sets/character-sets.xhtml.
......
...@@ -829,7 +829,7 @@ restrictions imposed by *s*. ...@@ -829,7 +829,7 @@ restrictions imposed by *s*.
The ``in`` and ``not in`` operations have the same priorities as the The ``in`` and ``not in`` operations have the same priorities as the
comparison operations. The ``+`` (concatenation) and ``*`` (repetition) comparison operations. The ``+`` (concatenation) and ``*`` (repetition)
operations have the same priority as the corresponding numeric operations. operations have the same priority as the corresponding numeric operations. [3]_
.. index:: .. index::
triple: operations on; sequence; types triple: operations on; sequence; types
......
...@@ -248,7 +248,7 @@ utility to most DOM users. ...@@ -248,7 +248,7 @@ utility to most DOM users.
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#] The encoding name included in the XML output should conform to .. [1] The encoding name included in the XML output should conform to
the appropriate standards. For example, "UTF-8" is valid, but the appropriate standards. For example, "UTF-8" is valid, but
"UTF8" is not valid in an XML document's declaration, even though "UTF8" is not valid in an XML document's declaration, even though
Python accepts it as an encoding name. Python accepts it as an encoding name.
......
...@@ -1192,7 +1192,7 @@ Exceptions ...@@ -1192,7 +1192,7 @@ Exceptions
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#] The encoding string included in XML output should conform to the .. [1] The encoding string included in XML output should conform to the
appropriate standards. For example, "UTF-8" is valid, but "UTF8" is appropriate standards. For example, "UTF-8" is valid, but "UTF8" is
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
and https://www.iana.org/assignments/character-sets/character-sets.xhtml. and https://www.iana.org/assignments/character-sets/character-sets.xhtml.
...@@ -106,7 +106,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2 ...@@ -106,7 +106,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2
howto/pyporting,,::,Programming Language :: Python :: 3 howto/pyporting,,::,Programming Language :: Python :: 3
howto/regex,,::, howto/regex,,::,
howto/regex,,:foo,(?:foo) howto/regex,,:foo,(?:foo)
howto/urllib2,,:password,"for example ""joe:password@example.com""" howto/urllib2,,:password,"""joe:password@example.com"""
library/audioop,,:ipos,"# factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)]," library/audioop,,:ipos,"# factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],"
library/bisect,32,:hi,all(val >= x for val in a[i:hi]) library/bisect,32,:hi,all(val >= x for val in a[i:hi])
library/bisect,42,:hi,all(val > x for val in a[i:hi]) library/bisect,42,:hi,all(val > x for val in a[i:hi])
...@@ -316,8 +316,8 @@ library/xml.etree.elementtree,,:actor,"for actor in root.findall('real_person:ac ...@@ -316,8 +316,8 @@ library/xml.etree.elementtree,,:actor,"for actor in root.findall('real_person:ac
library/xml.etree.elementtree,,:name,"name = actor.find('real_person:name', ns)" library/xml.etree.elementtree,,:name,"name = actor.find('real_person:name', ns)"
library/xml.etree.elementtree,,:character,"for char in actor.findall('role:character', ns):" library/xml.etree.elementtree,,:character,"for char in actor.findall('role:character', ns):"
library/zipapp,,:main,"$ python -m zipapp myapp -m ""myapp:main""" library/zipapp,,:main,"$ python -m zipapp myapp -m ""myapp:main"""
library/zipapp,,:fn,"argument should have the form ""pkg.mod:fn"", where ""pkg.mod"" is a" library/zipapp,,:fn,"pkg.mod:fn"
library/zipapp,,:callable,"""pkg.module:callable"" and the archive will be run by importing" library/zipapp,,:callable,"pkg.module:callable"
library/stdtypes,,::,>>> m[::2].tolist() library/stdtypes,,::,>>> m[::2].tolist()
library/sys,,`,# ``wrapper`` creates a ``wrap(coro)`` coroutine: library/sys,,`,# ``wrapper`` creates a ``wrap(coro)`` coroutine:
whatsnew/3.5,,:root,'WARNING:root:warning\n' whatsnew/3.5,,:root,'WARNING:root:warning\n'
...@@ -326,7 +326,6 @@ whatsnew/3.5,,::,>>> addr6 = ipaddress.IPv6Address('::1') ...@@ -326,7 +326,6 @@ whatsnew/3.5,,::,>>> addr6 = ipaddress.IPv6Address('::1')
whatsnew/3.5,,:root,ERROR:root:exception whatsnew/3.5,,:root,ERROR:root:exception
whatsnew/3.5,,:exception,ERROR:root:exception whatsnew/3.5,,:exception,ERROR:root:exception
whatsnew/changelog,,:version,import sys; I = version[:version.index(' ')] whatsnew/changelog,,:version,import sys; I = version[:version.index(' ')]
whatsnew/changelog,,`,"for readability (was ""`"")."
whatsnew/changelog,,:end,str[start:end] whatsnew/changelog,,:end,str[start:end]
library/binascii,,`,'`' library/binascii,,`,'`'
library/uu,,`,'`' library/uu,,`,'`'
......
...@@ -769,7 +769,7 @@ Library ...@@ -769,7 +769,7 @@ Library
non-None value is passed to it.send(val). non-None value is passed to it.send(val).
- Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix - Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix
for readability (was "`"). for readability.
- Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin - Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin
a workaround to Tix library bug. a workaround to Tix library bug.
...@@ -1624,7 +1624,7 @@ Library ...@@ -1624,7 +1624,7 @@ Library
non-None value is passed to it.send(val). non-None value is passed to it.send(val).
- Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix - Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix
for readability (was "`"). for readability.
- Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin - Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin
a workaround to Tix library bug. a workaround to Tix library bug.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment