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

[Julien Palard]

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

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

(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 df76b943b794..d82514f60519 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -41,6 +41,8 @@
 # Require Sphinx 1.2 for build.
 needs_sphinx = '1.2'
 
+# 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