mirror of
https://github.com/python/cpython.git
synced 2025-11-03 23:21:29 +00:00
141 lines
4.5 KiB
Python
141 lines
4.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Python documentation build configuration file
|
|
#
|
|
# This file is execfile()d with the current directory set to its containing dir.
|
|
#
|
|
# The contents of this file are pickled, so don't put values in the namespace
|
|
# that aren't pickleable (module imports are okay, they're removed automatically).
|
|
|
|
import sys, os, time
|
|
sys.path.append('tools/sphinxext')
|
|
|
|
# General configuration
|
|
# ---------------------
|
|
|
|
extensions = ['sphinx.addons.refcounting']
|
|
|
|
# General substitutions.
|
|
project = 'Python'
|
|
copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y')
|
|
|
|
# The default replacements for |version| and |release|.
|
|
#
|
|
# The short X.Y version.
|
|
# version = '2.6'
|
|
# The full version, including alpha/beta/rc tags.
|
|
# release = '2.6a0'
|
|
|
|
# We look for the Include/patchlevel.h file in the current Python source tree
|
|
# and replace the values accordingly.
|
|
import patchlevel
|
|
version, release = patchlevel.get_version_info()
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
# non-false value, then it is used:
|
|
today = ''
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
today_fmt = '%B %d, %Y'
|
|
|
|
# List of files that shouldn't be included in the build.
|
|
unused_files = [
|
|
'whatsnew/2.0.rst',
|
|
'whatsnew/2.1.rst',
|
|
'whatsnew/2.2.rst',
|
|
'whatsnew/2.3.rst',
|
|
'whatsnew/2.4.rst',
|
|
'whatsnew/2.5.rst',
|
|
'maclib/scrap.rst',
|
|
'library/xmllib.rst',
|
|
'library/xml.etree.rst',
|
|
]
|
|
|
|
# Relative filename of the reference count data file.
|
|
refcount_file = 'data/refcounts.dat'
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = True
|
|
|
|
|
|
# Options for HTML output
|
|
# -----------------------
|
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
# using the given strftime format.
|
|
html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
# typographically correct entities.
|
|
html_use_smartypants = True
|
|
|
|
# Content template for the index page, filename relative to this file.
|
|
html_index = 'tools/sphinxext/indexcontent.html'
|
|
|
|
# Custom sidebar templates, filenames relative to this file.
|
|
html_sidebars = {
|
|
'index': 'tools/sphinxext/indexsidebar.html',
|
|
}
|
|
|
|
# Additional templates that should be rendered to pages.
|
|
html_additional_pages = {
|
|
'download': 'tools/sphinxext/download.html',
|
|
}
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'pydoc'
|
|
|
|
|
|
# Options for LaTeX output
|
|
# ------------------------
|
|
|
|
# The paper size ('letter' or 'a4').
|
|
latex_paper_size = 'a4'
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
latex_font_size = '10pt'
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, document class [howto/manual]).
|
|
_stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor'
|
|
latex_documents = [
|
|
('c-api/index.rst', 'c-api.tex',
|
|
'The Python/C API', _stdauthor, 'manual'),
|
|
('distutils/index.rst', 'distutils.tex',
|
|
'Distributing Python Modules', _stdauthor, 'manual'),
|
|
('documenting/index.rst', 'documenting.tex',
|
|
'Documenting Python', 'Georg Brandl', 'manual'),
|
|
('extending/index.rst', 'extending.tex',
|
|
'Extending and Embedding Python', _stdauthor, 'manual'),
|
|
('install/index.rst', 'install.tex',
|
|
'Installing Python Modules', _stdauthor, 'manual'),
|
|
('library/index.rst', 'library.tex',
|
|
'The Python Library Reference', _stdauthor, 'manual'),
|
|
('reference/index.rst', 'reference.tex',
|
|
'The Python Language Reference', _stdauthor, 'manual'),
|
|
('tutorial/index.rst', 'tutorial.tex',
|
|
'Python Tutorial', _stdauthor, 'manual'),
|
|
('using/index.rst', 'using.tex',
|
|
'Using Python', _stdauthor, 'manual'),
|
|
('whatsnew/' + version + '.rst', 'whatsnew.tex',
|
|
'What\'s New in Python', 'A. M. Kuchling', 'howto'),
|
|
]
|
|
# Collect all HOWTOs individually
|
|
latex_documents.extend(('howto/' + fn, 'howto-' + fn[:-4] + '.tex',
|
|
'HOWTO', _stdauthor, 'howto')
|
|
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}
|
|
}
|
|
'''
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
latex_appendices = ['glossary.rst', 'about.rst', 'license.rst', 'copyright.rst']
|