]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[2.7] bpo-35605: Fix documentation build for sphinx<1.6 (GH-12413)
authorJulien Palard <julien@palard.fr>
Mon, 18 Mar 2019 18:11:30 +0000 (19:11 +0100)
committerGitHub <noreply@github.com>
Mon, 18 Mar 2019 18:11:30 +0000 (19:11 +0100)
(cherry picked from commit dfc8fc15fa989acba3c372572e52bbcb5ab38a37)

Doc/conf.py
Doc/tools/extensions/pyspecific.py
Misc/NEWS.d/next/Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst [new file with mode: 0644]

index 557fe1e72f277662057d2a39579e66e47acd0054..df76b943b794462b550e5e8c003821cde45f95fb 100644 (file)
@@ -57,7 +57,7 @@ templates_path = ['tools/templates']
 
 # Custom sidebar templates, filenames relative to this file.
 html_sidebars = {
-    'index': 'indexsidebar.html',
+    'index': ['indexsidebar.html'],
 }
 
 # Additional templates that should be rendered to pages.
index 6378f76bdc2cf14cb50d49bd8a06323b867902e9..1ec88c23e01bf2414aa9f2e578a1c017372409da 100644 (file)
@@ -15,7 +15,6 @@ SOURCE_URI = 'https://github.com/python/cpython/tree/2.7/%s'
 from docutils import nodes, utils
 from docutils.parsers.rst import Directive
 
-from sphinx.util import status_iterator
 from sphinx.util.nodes import split_explicit_title
 from sphinx.writers.html import HTMLTranslator
 from sphinx.writers.latex import LaTeXTranslator
@@ -173,6 +172,11 @@ class PydocTopicsBuilder(Builder):
         return ''  # no URIs
 
     def write(self, *ignored):
+        try:  # sphinx>=1.6
+            from sphinx.util import status_iterator
+        except ImportError:  # sphinx<1.6
+            status_iterator = self.status_iterator
+
         writer = TextWriter(self)
         for label in status_iterator(pydoc_topic_labels,
                                      'building topics... ',
diff --git a/Misc/NEWS.d/next/Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst b/Misc/NEWS.d/next/Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst
new file mode 100644 (file)
index 0000000..cbc0f1e
--- /dev/null
@@ -0,0 +1 @@
+Fix documentation build for sphinx<1.6.  Patch by Anthony Sottile.