DOC: Disable build against Sphinx 1.5.0 #7569
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was deprecated in Sphinx 1.4 and causes a warning in 1.5, which kills the build due to warnings-as-errors.
Merged
|
I would just update doc-requirements to require sphinx>=1.4. |
|
That's only Mar 28, 2016; seems a bit new. |
|
In the process of doing exactly this too. There are 2 more: 02:11 $ git diff
diff --git a/doc/conf.py b/doc/conf.py
index d9619d1..037fc80 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -241,9 +241,6 @@ html_favicon = '_static/favicon.ico'
# 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 @@ latex_documents = [
# 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,14 +277,17 @@ latex_preamble = r"""
\usepackage{enumitem}
\setlistdepth{2048}
"""
+latex_elements['pointsize'] = '11pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
# Documents to append as an appendix to all manuals.
latex_appendices = []
# If false, no module index is generated.
latex_use_modindex = True
-latex_use_parts = True
+latex_toplevel_sectioning = 'part'
# Show both class-level docstring and __init__ docstring in class
# documentation
|
|
We should probably shim it for the sake of people building on top of old system packages. |
|
can you also backport this to 1.5.3-doc? |
|
|
They were deprecated in Sphinx 0.5.
e5daf7a to
c2015e1
Compare
Every single builtin extension does not declare whether it is parallel read safe, causing our warnings-as-errors build to fail no matter what.
|
Sphinx 1.5.0 now warns about a majority of its internal extensions that are not parallel read safe, making it impossible for us to fix right now; I've just changed requirements to not allow 1.5.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This was deprecated in Sphinx 1.4 and causes a warning in 1.5, which kills the build due to warnings-as-errors.
This is breaking both master and v2.x doc builds, so I will self-merge this after CI passes.