Skip to content

Commit

Permalink
[2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616)
Browse files Browse the repository at this point in the history
* 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 d97b7dc)
  • Loading branch information
serhiy-storchaka authored May 16, 2017
1 parent 97eb2a7 commit b8b9f95
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 10 deletions.
10 changes: 5 additions & 5 deletions Doc/howto/urllib2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ handling common situations - like basic authentication, cookies, proxies and so
on. These are provided by objects called handlers and openers.

urllib2 supports fetching URLs for many "URL schemes" (identified by the string
before the ":" in URL - for example "ftp" is the URL scheme of
"ftp://python.org/") using their associated network protocols (e.g. FTP, HTTP).
before the ``":"`` in URL - for example ``"ftp"`` is the URL scheme of
``"ftp://python.org/"``) using their associated network protocols (e.g. FTP, HTTP).
This tutorial focuses on the most common case, HTTP.

For straightforward situations *urlopen* is very easy to use. But as soon as you
Expand Down Expand Up @@ -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
component and the hostname and optionally the port number)
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"
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"``
(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.


Expand Down
1 change: 1 addition & 0 deletions Doc/library/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,7 @@ section.


.. class:: list([iterable])
:noindex:

This comment has been minimized.

Copy link
@dmitrytokarev

dmitrytokarev Jun 30, 2017

@serhiy-storchaka I suspect this addition broke links in documentation for Python2.7:
https://docs.python.org/2.7/library/functions.html
See that list is not clickable. I haven't researched yet if the bug has been logged.

This comment has been minimized.

Copy link
@dmitrytokarev

dmitrytokarev Jun 30, 2017

Addressing this in #2518

This comment has been minimized.

Copy link
@serhiy-storchaka

serhiy-storchaka Jun 30, 2017

Author Member

Good point Dmitry!


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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/pyexpat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -911,7 +911,7 @@ The ``errors`` object has the following attributes:

.. 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
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
and https://www.iana.org/assignments/character-sets/character-sets.xhtml.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/xml.dom.minidom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ utility to most DOM users.

.. 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
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
and https://www.iana.org/assignments/character-sets/character-sets.xhtml.
2 changes: 1 addition & 1 deletion Doc/library/xml.etree.elementtree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1031,7 +1031,7 @@ This is an example of counting the maximum depth of an XML file::

.. 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
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
and https://www.iana.org/assignments/character-sets/character-sets.xhtml.
4 changes: 2 additions & 2 deletions Doc/tools/susp-ignored.csv
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2
howto/pyporting,,::,Programming Language :: Python :: 3
howto/regex,,::,
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/bisect,,:hi,all(val >= x for val in a[i:hi])
library/bisect,,:hi,all(val > x for val in a[i:hi])
Expand Down Expand Up @@ -152,7 +152,7 @@ reference/datamodel,,:step,a[i:j:step]
reference/datamodel,,:max,
reference/expressions,,:index,x[index:index]
reference/expressions,,`,`expressions...`
reference/expressions,,`,"""`"""
reference/expressions,350,`,`
reference/grammar,,`,'`' testlist1 '`'
reference/lexical_analysis,,:fileencoding,# vim:fileencoding=<encoding-name>
reference/lexical_analysis,,`,", : . ` = ;"
Expand Down

0 comments on commit b8b9f95

Please sign in to comment.