Skip to content

DOC: Disable build against Sphinx 1.5.0 #7569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 5, 2016
Merged

DOC: Disable build against Sphinx 1.5.0 #7569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f051405
DOC: Avoid deprecated latex_use_parts option.
QuLogic Dec 5, 2016
c2015e1
DOC: Use latex_elements instead of individual settings.
tacaswell Dec 5, 2016
63656a4
DOC: Disable build against Sphinx 1.5.0.
QuLogic Dec 5, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 7 additions & 5 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]).

Expand All @@ -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).
Expand All @@ -279,14 +277,18 @@
\usepackage{enumitem}
\setlistdepth{2048}
"""
latex_elements['pointsize'] = '11pt'

# 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
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
Expand Down