From 869652b426bb34a30ce7b39f0a0ac242ed5b1016 Mon Sep 17 00:00:00 2001
From: Julien Palard <julien@palard.fr>
Date: Mon, 18 Mar 2019 19:11:30 +0100
Subject: [PATCH] [2.7] bpo-35605: Fix documentation build for sphinx<1.6
(GH-12413)
(cherry picked from commit dfc8fc15fa989acba3c372572e52bbcb5ab38a37)
---
Doc/conf.py | 2 +-
Doc/tools/extensions/pyspecific.py | 6 +++++-
.../Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst | 1 +
3 files changed, 7 insertions(+), 2 deletions(-)
create mode 100644 Misc/NEWS.d/next/Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst
diff --git a/Doc/conf.py b/Doc/conf.py
index 557fe1e72f27..df76b943b794 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -57,7 +57,7 @@
# Custom sidebar templates, filenames relative to this file.
html_sidebars = {
- 'index': 'indexsidebar.html',
+ 'index': ['indexsidebar.html'],
}
# Additional templates that should be rendered to pages.
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 6378f76bdc2c..1ec88c23e01b 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -15,7 +15,6 @@
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 @@ def get_target_uri(self, docname, typ=None):
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
index 000000000000..cbc0f1e07f31
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-12-30-09-56-13.bpo-35605.gAWt32.rst
@@ -0,0 +1 @@
+Fix documentation build for sphinx<1.6. Patch by Anthony Sottile.