blob: 76415b06a93530e3b78ea4340eca2d3e1d2e9eb4 [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001# -*- coding: utf-8 -*-
2#
3# Python documentation build configuration file
4#
Georg Brandl7155a092008-01-16 20:27:56 +00005# This file is execfile()d with the current directory set to its containing dir.
6#
Georg Brandl8ec7f652007-08-15 14:28:01 +00007# The contents of this file are pickled, so don't put values in the namespace
8# that aren't pickleable (module imports are okay, they're removed automatically).
Georg Brandleee1fc52007-12-16 19:36:51 +00009
Georg Brandldd76e052008-01-21 20:20:53 +000010import sys, os, time
Georg Brandlb4d21132008-04-12 18:11:18 +000011sys.path.append(os.path.abspath('tools/sphinxext'))
Georg Brandldd76e052008-01-21 20:20:53 +000012
Georg Brandleee1fc52007-12-16 19:36:51 +000013# General configuration
14# ---------------------
Georg Brandl8ec7f652007-08-15 14:28:01 +000015
Georg Brandl17baef02008-03-22 10:56:23 +000016extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage',
Georg Brandlc3051922008-04-09 17:58:56 +000017 'sphinx.ext.doctest', 'pyspecific']
Georg Brandl5bb647d2008-03-09 18:18:30 +000018templates_path = ['tools/sphinxext']
Georg Brandl56eadd92008-01-27 20:25:12 +000019
Georg Brandl7155a092008-01-16 20:27:56 +000020# General substitutions.
21project = 'Python'
Georg Brandldd76e052008-01-21 20:20:53 +000022copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y')
Georg Brandl7155a092008-01-16 20:27:56 +000023
Georg Brandl8ec7f652007-08-15 14:28:01 +000024# The default replacements for |version| and |release|.
Georg Brandl8ec7f652007-08-15 14:28:01 +000025#
26# The short X.Y version.
27# version = '2.6'
Georg Brandl8ec7f652007-08-15 14:28:01 +000028# The full version, including alpha/beta/rc tags.
29# release = '2.6a0'
Georg Brandldd76e052008-01-21 20:20:53 +000030
31# We look for the Include/patchlevel.h file in the current Python source tree
32# and replace the values accordingly.
33import patchlevel
34version, release = patchlevel.get_version_info()
Georg Brandl8ec7f652007-08-15 14:28:01 +000035
36# There are two options for replacing |today|: either, you set today to some
37# non-false value, then it is used:
38today = ''
39# Else, today_fmt is used as the format for a strftime call.
40today_fmt = '%B %d, %Y'
41
Georg Brandl8ec7f652007-08-15 14:28:01 +000042# List of files that shouldn't be included in the build.
Georg Brandl14a1b8c2008-02-09 23:09:25 +000043unused_docs = [
Georg Brandl14a1b8c2008-02-09 23:09:25 +000044 'maclib/scrap',
45 'library/xmllib',
46 'library/xml.etree',
Georg Brandl8ec7f652007-08-15 14:28:01 +000047]
48
Georg Brandl7155a092008-01-16 20:27:56 +000049# Relative filename of the reference count data file.
50refcount_file = 'data/refcounts.dat'
51
Georg Brandl8ec7f652007-08-15 14:28:01 +000052# If true, '()' will be appended to :func: etc. cross-reference text.
53add_function_parentheses = True
54
55# If true, the current module name will be prepended to all description
56# unit titles (such as .. function::).
57add_module_names = True
Georg Brandleee1fc52007-12-16 19:36:51 +000058
59
60# Options for HTML output
61# -----------------------
62
Georg Brandleee1fc52007-12-16 19:36:51 +000063# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
64# using the given strftime format.
65html_last_updated_fmt = '%b %d, %Y'
66
67# If true, SmartyPants will be used to convert quotes and dashes to
68# typographically correct entities.
69html_use_smartypants = True
70
Georg Brandl7155a092008-01-16 20:27:56 +000071# Custom sidebar templates, filenames relative to this file.
72html_sidebars = {
Georg Brandl5bb647d2008-03-09 18:18:30 +000073 'index': 'indexsidebar.html',
Georg Brandl7155a092008-01-16 20:27:56 +000074}
75
76# Additional templates that should be rendered to pages.
77html_additional_pages = {
Georg Brandl5bb647d2008-03-09 18:18:30 +000078 'download': 'download.html',
Georg Brandl1df986b2008-04-19 21:28:38 +000079 'index': 'indexcontent.html',
Georg Brandl7155a092008-01-16 20:27:56 +000080}
81
Georg Brandl4f1f36b2008-04-27 20:03:05 +000082# Output an OpenSearch description file.
Georg Brandl761b9c62008-05-03 20:16:47 +000083html_use_opensearch = 'http://docs.python.org/dev'
Georg Brandl4f1f36b2008-04-27 20:03:05 +000084
85# Additional static files.
86html_static_path = ['tools/sphinxext/static']
87
Georg Brandl7155a092008-01-16 20:27:56 +000088# Output file base name for HTML help builder.
Georg Brandl47dff402008-03-02 06:45:40 +000089htmlhelp_basename = 'python' + release.replace('.', '')
Georg Brandl7155a092008-01-16 20:27:56 +000090
Georg Brandl5c15aba2008-06-17 09:01:35 +000091# Split the index
92html_split_index = True
93
Georg Brandleee1fc52007-12-16 19:36:51 +000094
95# Options for LaTeX output
96# ------------------------
97
Georg Brandl7155a092008-01-16 20:27:56 +000098# The paper size ('letter' or 'a4').
99latex_paper_size = 'a4'
Georg Brandleee1fc52007-12-16 19:36:51 +0000100
Georg Brandl7155a092008-01-16 20:27:56 +0000101# The font size ('10pt', '11pt' or '12pt').
102latex_font_size = '10pt'
103
104# Grouping the document tree into LaTeX files. List of tuples
105# (source start file, target name, title, author, document class [howto/manual]).
106_stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor'
107latex_documents = [
Georg Brandla51f61b2008-02-01 20:45:33 +0000108 ('c-api/index', 'c-api.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000109 'The Python/C API', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000110 ('distutils/index', 'distutils.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000111 'Distributing Python Modules', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000112 ('documenting/index', 'documenting.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000113 'Documenting Python', 'Georg Brandl', 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000114 ('extending/index', 'extending.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000115 'Extending and Embedding Python', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000116 ('install/index', 'install.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000117 'Installing Python Modules', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000118 ('library/index', 'library.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000119 'The Python Library Reference', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000120 ('reference/index', 'reference.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000121 'The Python Language Reference', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000122 ('tutorial/index', 'tutorial.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000123 'Python Tutorial', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000124 ('using/index', 'using.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000125 'Using Python', _stdauthor, 'manual'),
Georg Brandla51f61b2008-02-01 20:45:33 +0000126 ('whatsnew/' + version, 'whatsnew.tex',
Georg Brandl7155a092008-01-16 20:27:56 +0000127 'What\'s New in Python', 'A. M. Kuchling', 'howto'),
128]
129# Collect all HOWTOs individually
Georg Brandla51f61b2008-02-01 20:45:33 +0000130latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex',
Georg Brandlbb608a82008-12-05 08:35:09 +0000131 '', _stdauthor, 'howto')
Georg Brandl7155a092008-01-16 20:27:56 +0000132 for fn in os.listdir('howto')
133 if fn.endswith('.rst') and fn != 'index.rst')
134
135# Additional stuff for the LaTeX preamble.
136latex_preamble = r'''
137\authoraddress{
138 \strong{Python Software Foundation}\\
139 Email: \email{docs@python.org}
140}
Georg Brandl90a79e82008-11-19 11:34:07 +0000141\let\Verbatim=\OriginalVerbatim
142\let\endVerbatim=\endOriginalVerbatim
Georg Brandl7155a092008-01-16 20:27:56 +0000143'''
144
145# Documents to append as an appendix to all manuals.
Georg Brandla51f61b2008-02-01 20:45:33 +0000146latex_appendices = ['glossary', 'about', 'license', 'copyright']
Georg Brandl17048282008-02-23 18:47:04 +0000147
Georg Brandl805e6bc2008-11-27 19:06:37 +0000148latex_elements = {'inputenc': '\\usepackage[utf8x]{inputenc}'}
149
Georg Brandl17048282008-02-23 18:47:04 +0000150# Options for the coverage checker
151# --------------------------------
152
153# The coverage checker will ignore all modules/functions/classes whose names
154# match any of the following regexes (using re.match).
155coverage_ignore_modules = [
156 r'[T|t][k|K]',
157 r'Tix',
158 r'distutils.*',
159]
160
161coverage_ignore_functions = [
162 'test($|_)',
163]
164
165coverage_ignore_classes = [
166]
167
168# Glob patterns for C source files for C API coverage, relative to this directory.
169coverage_c_path = [
170 '../Include/*.h',
171]
172
173# Regexes to find C items in the source files.
174coverage_c_regexes = {
175 'cfunction': (r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'),
176 'data': (r'^PyAPI_DATA\(.*\)\s+([^_][\w_]+)'),
177 'macro': (r'^#define ([^_][\w_]+)\(.*\)[\s|\\]'),
178}
179
180# The coverage checker will ignore all C items whose names match these regexes
181# (using re.match) -- the keys must be the same as in coverage_c_regexes.
182coverage_ignore_c_items = {
183# 'cfunction': [...]
184}