From f051405bb8bc72c60d16ae7e46a74a5288d5c099 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Mon, 5 Dec 2016 01:51:39 -0500 Subject: [PATCH 1/3] DOC: Avoid deprecated latex_use_parts option. This was deprecated in Sphinx 1.4 and causes a warning in 1.5, which kills the build due to warnings-as-errors. --- doc/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index d9619d104708..f4e36a192ab9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -286,7 +286,10 @@ # If false, no module index is generated. latex_use_modindex = True -latex_use_parts = True +if hasattr(sphinx, 'version_info') and sphinx.version_info[:2] >= (1, 4): + latex_toplevel_sectioning = 'part' +else: + latex_use_parts = True # Show both class-level docstring and __init__ docstring in class # documentation From c2015e13b552a2d977772a7051e03092833a8495 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Mon, 5 Dec 2016 02:17:33 -0500 Subject: [PATCH 2/3] DOC: Use latex_elements instead of individual settings. They were deprecated in Sphinx 0.5. --- doc/conf.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index f4e36a192ab9..849ac11ec8dc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -241,9 +241,6 @@ # The paper size ('letter' or 'a4'). latex_paper_size = 'letter' -# The font size ('10pt', '11pt' or '12pt'). -latex_font_size = '11pt' - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). @@ -258,8 +255,9 @@ # the title page. latex_logo = None +latex_elements = {} # Additional stuff for the LaTeX preamble. -latex_preamble = r""" +latex_elements['preamble'] = r""" % In the parameters section, place a newline after the Parameters % header. (This is stolen directly from Numpy's conf.py, since it % affects Numpy-style docstrings). @@ -279,6 +277,7 @@ \usepackage{enumitem} \setlistdepth{2048} """ +latex_elements['pointsize'] = '11pt' # Documents to append as an appendix to all manuals. latex_appendices = [] From 63656a412f6dad3b8ed51cf37e8b08771aad24fe Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Mon, 5 Dec 2016 02:47:32 -0500 Subject: [PATCH 3/3] DOC: Disable build against Sphinx 1.5.0. Every single builtin extension does not declare whether it is parallel read safe, causing our warnings-as-errors build to fail no matter what. --- doc-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-requirements.txt b/doc-requirements.txt index 9c2c189e9151..e62282562ea0 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -6,7 +6,7 @@ # Install the documentation requirements with: # pip install -r doc-requirements.txt # -sphinx>1.0 +sphinx>1.0,!=1.5.0 numpydoc ipython mock