]> granicus.if.org Git - python/commitdiff
Fix some sphinx warnings (#9)
authorRyan Gonzalez <refi64@users.noreply.github.com>
Sat, 11 Feb 2017 04:47:37 +0000 (22:47 -0600)
committerINADA Naoki <methane@users.noreply.github.com>
Sat, 11 Feb 2017 04:47:37 +0000 (13:47 +0900)
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS

Doc/Makefile
Doc/conf.py
Misc/NEWS

index 91f937f985831afeb2503ec25104509c4a4ef1c3..6e1c18304080d6b0b893c83682e23bd6e2fedb7e 100644 (file)
@@ -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 \
index b1bb6208bb4b8e6d6c0b1d5b72f697c767ac7e7b..b3f26d5a692163abefccfc842d4480ec21596595 100644 (file)
@@ -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
 # -----------------------
 
index 5feaac7c387191697dbf2a46088fb50f86405d83..48d786d8f7b50573b73c8bb6dd3e4b74fd90d729 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -661,7 +661,7 @@ C API
   PY_SSIZE_T_CLEAN is defined.
 
 - Issue #28769: The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8()
-  is now of type "const char *" rather of "char *".
+  is now of type ``const char *`` rather of ``char *``.
 
 - Issue #29058: All stable API extensions added after Python 3.2 are now
   available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of