[Python-checkins] [3.7] bpo-35564: add master_doc='contents' to conf.py (GH-12460)

Julien Palard webhook-mailer at python.org
Wed Mar 20 05:40:35 EDT 2019


https://github.com/python/cpython/commit/756cfd88920c2349d4546024856c406409b0ab7b
commit: 756cfd88920c2349d4546024856c406409b0ab7b
branch: 3.7
author: Julien Palard <julien at palard.fr>
committer: GitHub <noreply at github.com>
date: 2019-03-20T10:40:30+01:00
summary:

[3.7] bpo-35564: add master_doc='contents' to conf.py (GH-12460)

(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 eab3c39cfb7c..da8b9d7b2a65 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -46,6 +46,8 @@
     'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'], 'builders': ['man', 'text'],
 }
 
+# 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