Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Fix some sphinx warnings (#9) 

* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
This commit is contained in:
Ryan Gonzalez 2017-02-10 22:47:37 -06:00 committed by INADA Naoki
parent 29896ad3d3
commit e7ffb99f84
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/Makefile
View File

@ -10,7 +10,7 @@ PAPER =
SOURCES = SOURCES =
DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py) 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) $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
.PHONY: help build html htmlhelp latex text changes linkcheck \ .PHONY: help build html htmlhelp latex text changes linkcheck \

30
Doc/conf.py
View File

@ -88,11 +88,24 @@ html_split_index = True
# Options for LaTeX output # 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'). # The paper size ('letter' or 'a4').
latex_paper_size = 'a4' latex_elements['papersize'] = 'a4'
# The font size ('10pt', '11pt' or '12pt'). # 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 # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]). # (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') for fn in os.listdir('howto')
if fn.endswith('.rst') and fn != 'index.rst') 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. # Documents to append as an appendix to all manuals.
latex_appendices = ['glossary', 'about', 'license', 'copyright'] latex_appendices = ['glossary', 'about', 'license', 'copyright']
# Get LaTeX to handle Unicode correctly
latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}', 'utf8extra': ''}
# Options for Epub output # Options for Epub output
# ----------------------- # -----------------------

2
Misc/NEWS
View File

@ -661,7 +661,7 @@ C API
PY_SSIZE_T_CLEAN is defined. PY_SSIZE_T_CLEAN is defined.
- Issue #28769: The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8() - 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 - 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 available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of