diff options
| author | Mariatta <Mariatta@users.noreply.github.com> | 2017-02-14 14:12:15 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-02-14 14:12:15 (GMT) |
| commit | c0f9014a51593b2d58721819f8686f96dce5be71 (patch) | |
| tree | e42fac7aad6b5800eb8e61b51732b7a15fb4d64f | |
| parent | 3ae8fd43fd18160dcb619d7d367cb1b41aeab32a (diff) | |
| download | cpython-c0f9014a51593b2d58721819f8686f96dce5be71.zip cpython-c0f9014a51593b2d58721819f8686f96dce5be71.tar.gz cpython-c0f9014a51593b2d58721819f8686f96dce5be71.tar.bz2 | |
Fix some sphinx warnings (#9) (#82)
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
Contributed by Ryan Gonzalez @kirbyfan64
(cherry picked from commit e7ffb99f842ebff97cffa0fc90b18be4e5abecf2)
| -rw-r--r-- | Doc/Makefile | 2 | ||||
| -rw-r--r-- | Doc/conf.py | 30 |
2 files changed, 16 insertions, 16 deletions
diff --git a/Doc/Makefile b/Doc/Makefile index 10c3288..9ad7b86 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -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 \ diff --git a/Doc/conf.py b/Doc/conf.py index b1bb620..b3f26d5 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -88,11 +88,24 @@ html_split_index = True # 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]). @@ -125,22 +138,9 @@ latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex', 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 # ----------------------- |