From: Serhiy Storchaka Date: Tue, 16 May 2017 22:26:48 +0000 (+0300) Subject: [2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616) X-Git-Tag: v2.7.14rc1~145 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b8b9f95f660d00ce9bd11bd9de429176858be3c5;p=python [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 d97b7dc94b19063f0589d401bdc4aaadc7030762) --- diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst index f6cba75544..d697c216d8 100644 --- a/Doc/howto/urllib2.rst +++ b/Doc/howto/urllib2.rst @@ -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 @@ -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. diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index c1ce258661..c82a897b84 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -741,6 +741,7 @@ section. .. class:: list([iterable]) + :noindex: 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 diff --git a/Doc/library/pyexpat.rst b/Doc/library/pyexpat.rst index ffa042b7bc..9ac55720e7 100644 --- a/Doc/library/pyexpat.rst +++ b/Doc/library/pyexpat.rst @@ -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. diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index a1d7951e48..f91259a8fb 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -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. diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 08b677bddc..39d811be6d 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -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. diff --git a/Doc/tools/susp-ignored.csv b/Doc/tools/susp-ignored.csv index de4a81fb71..f7d23e22ba 100644 --- a/Doc/tools/susp-ignored.csv +++ b/Doc/tools/susp-ignored.csv @@ -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]) @@ -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= reference/lexical_analysis,,`,", : . ` = ;"