Skip to content

Commit

Permalink
Fix some sphinx warnings (#9) (#82)
Browse files Browse the repository at this point in the history
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS

Contributed by Ryan Gonzalez @kirbyfan64

(cherry picked from commit e7ffb99)
  • Loading branch information
Mariatta committed Feb 14, 2017
1 parent 3ae8fd4 commit c0f9014
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Doc/Makefile
Expand Up @@ -10,7 +10,7 @@ PAPER =
SOURCES =
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)

ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_elements.papersize=$(PAPER) \
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)

.PHONY: help build html htmlhelp latex text changes linkcheck \
Expand Down
30 changes: 15 additions & 15 deletions Doc/conf.py
Expand Up @@ -88,11 +88,24 @@
# Options for LaTeX output
# ------------------------

# Get LaTeX to handle Unicode correctly
latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}', 'utf8extra': ''}

# Additional stuff for the LaTeX preamble.
latex_elements['preamble'] = r'''
\authoraddress{
\strong{Python Software Foundation}\\
Email: \email{docs@python.org}
}
\let\Verbatim=\OriginalVerbatim
\let\endVerbatim=\endOriginalVerbatim
'''

# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
latex_elements['papersize'] = 'a4'

# The font size ('10pt', '11pt' or '12pt').
latex_font_size = '10pt'
latex_elements['font_size'] = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
Expand Down Expand Up @@ -125,22 +138,9 @@
for fn in os.listdir('howto')
if fn.endswith('.rst') and fn != 'index.rst')

# Additional stuff for the LaTeX preamble.
latex_preamble = r'''
\authoraddress{
\strong{Python Software Foundation}\\
Email: \email{docs@python.org}
}
\let\Verbatim=\OriginalVerbatim
\let\endVerbatim=\endOriginalVerbatim
'''

# Documents to append as an appendix to all manuals.
latex_appendices = ['glossary', 'about', 'license', 'copyright']

# Get LaTeX to handle Unicode correctly
latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}', 'utf8extra': ''}

# Options for Epub output
# -----------------------

Expand Down

0 comments on commit c0f9014

Please sign in to comment.