[Python-checkins] [3.6] bpo-35564: add master_doc='contents' to conf.py (GH-11290). (GH-12461)
Ned Deily
webhook-mailer at python.org
Wed Mar 20 11:41:40 EDT 2019
https://github.com/python/cpython/commit/4508bc37dd80c71adfaa0925a67c438389817076
commit: 4508bc37dd80c71adfaa0925a67c438389817076
branch: 3.6
author: Julien Palard <julien at palard.fr>
committer: Ned Deily <nad at python.org>
date: 2019-03-20T11:41:20-04:00
summary:
[3.6] bpo-35564: add master_doc='contents' to conf.py (GH-11290). (GH-12461)
(cherry picked from commit fc8284e22074af8154e9865c8391b955f13a308b)
Co-authored-by: Jean-François B <jfbu at free.fr>
files:
A Misc/NEWS.d/next/Documentation/2018-12-22-22-52-05.bpo-35564.TuEU_D.rst
M Doc/conf.py
diff --git a/Doc/conf.py b/Doc/conf.py
index e2758bcd00b5..fab963e23a0f 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -40,6 +40,8 @@
venvdir = os.getenv('VENVDIR', 'venv')
exclude_patterns = [venvdir+'/*', 'README.rst']
+# Avoid a warning with Sphinx >= 2.0
+master_doc = 'contents'
# Options for HTML output
# -----------------------
diff --git a/Misc/NEWS.d/next/Documentation/2018-12-22-22-52-05.bpo-35564.TuEU_D.rst b/Misc/NEWS.d/next/Documentation/2018-12-22-22-52-05.bpo-35564.TuEU_D.rst
new file mode 100644
index 000000000000..8ca95eed4c56
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-12-22-22-52-05.bpo-35564.TuEU_D.rst
@@ -0,0 +1 @@
+Explicitly set master_doc variable in conf.py for compliance with Sphinx 2.0
More information about the Python-checkins
mailing list