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

[2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616)

* Use explicit numbering for footnotes referred by explicit number.
* Fix literal strings formatting in howto/urllib2.rst.
* Add `:noindex:` to duplicated definition of list.
* Update susp-ignored.csv for reference/expressions.rst.
(cherry picked from commit d97b7dc9)
parent 97eb2a7d
...@@ -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.
urllib2 supports fetching URLs for many "URL schemes" (identified by the string urllib2 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
...@@ -498,10 +498,10 @@ than the URL you pass to .add_password() will also match. :: ...@@ -498,10 +498,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.
......
...@@ -741,6 +741,7 @@ section. ...@@ -741,6 +741,7 @@ section.
.. class:: list([iterable]) .. class:: list([iterable])
:noindex:
Return a list whose items are the same and in the same order as *iterable*'s Return a list whose items are the same and in the same order as *iterable*'s
items. *iterable* may be either a sequence, a container that supports items. *iterable* may be either a sequence, a container that supports
......
...@@ -911,7 +911,7 @@ The ``errors`` object has the following attributes: ...@@ -911,7 +911,7 @@ The ``errors`` object 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.
......
...@@ -273,7 +273,7 @@ utility to most DOM users. ...@@ -273,7 +273,7 @@ utility to most DOM users.
.. 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.
...@@ -1031,7 +1031,7 @@ This is an example of counting the maximum depth of an XML file:: ...@@ -1031,7 +1031,7 @@ This is an example of counting the maximum depth of an XML file::
.. 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.
...@@ -46,7 +46,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2 ...@@ -46,7 +46,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,,:hi,all(val >= x for val in a[i:hi]) library/bisect,,:hi,all(val >= x for val in a[i:hi])
library/bisect,,:hi,all(val > x for val in a[i:hi]) library/bisect,,:hi,all(val > x for val in a[i:hi])
...@@ -152,7 +152,7 @@ reference/datamodel,,:step,a[i:j:step] ...@@ -152,7 +152,7 @@ reference/datamodel,,:step,a[i:j:step]
reference/datamodel,,:max, reference/datamodel,,:max,
reference/expressions,,:index,x[index:index] reference/expressions,,:index,x[index:index]
reference/expressions,,`,`expressions...` reference/expressions,,`,`expressions...`
reference/expressions,,`,"""`""" reference/expressions,350,`,`
reference/grammar,,`,'`' testlist1 '`' reference/grammar,,`,'`' testlist1 '`'
reference/lexical_analysis,,:fileencoding,# vim:fileencoding=<encoding-name> reference/lexical_analysis,,:fileencoding,# vim:fileencoding=<encoding-name>
reference/lexical_analysis,,`,", : . ` = ;" reference/lexical_analysis,,`,", : . ` = ;"
......
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