Skip to content
Newer
Older
100644 187 lines (150 sloc) 5.62 KB
6e978f2 @jdhardy Add Python 2.7.2 documentation.
jdhardy authored Feb 25, 2012
1 # -*- coding: utf-8 -*-
2 #
3 # Python documentation build configuration file
4 #
5 # This file is execfile()d with the current directory set to its containing dir.
6 #
7 # 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).
9
10 import sys, os, time
11 sys.path.append(os.path.abspath('tools/sphinxext'))
12
13 # General configuration
14 # ---------------------
15
16 extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage',
17 'sphinx.ext.doctest', 'pyspecific']
18 templates_path = ['tools/sphinxext']
19
20 # General substitutions.
0c3d1db @jdhardy Make so small IronPython-specific changes to the documentation.
jdhardy authored Feb 26, 2012
21 project = 'IronPython'
22 copyright = 'IronPython Team; Microsoft Corporation; Python Software Foundation'
6e978f2 @jdhardy Add Python 2.7.2 documentation.
jdhardy authored Feb 25, 2012
23
24 # The default replacements for |version| and |release|.
25 #
26 # The short X.Y version.
27 # version = '2.6'
28 # The full version, including alpha/beta/rc tags.
29 # release = '2.6a0'
0c3d1db @jdhardy Make so small IronPython-specific changes to the documentation.
jdhardy authored Feb 26, 2012
30 version, release = '2.7','2.7.2b1'
6e978f2 @jdhardy Add Python 2.7.2 documentation.
jdhardy authored Feb 25, 2012
31
32 # There are two options for replacing |today|: either, you set today to some
33 # non-false value, then it is used:
34 today = ''
35 # Else, today_fmt is used as the format for a strftime call.
36 today_fmt = '%B %d, %Y'
37
38 # List of files that shouldn't be included in the build.
39 unused_docs = [
40 'maclib/scrap',
41 'library/xmllib',
42 'library/xml.etree',
43 ]
44
45 # Ignore .rst in Sphinx its self.
46 exclude_trees = ['tools/sphinx']
47
48 # Relative filename of the reference count data file.
49 refcount_file = 'data/refcounts.dat'
50
51 # If true, '()' will be appended to :func: etc. cross-reference text.
52 add_function_parentheses = True
53
54 # If true, the current module name will be prepended to all description
55 # unit titles (such as .. function::).
56 add_module_names = True
57
58
59 # Options for HTML output
60 # -----------------------
61
62 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
63 # using the given strftime format.
64 html_last_updated_fmt = '%b %d, %Y'
65
66 # If true, SmartyPants will be used to convert quotes and dashes to
67 # typographically correct entities.
68 html_use_smartypants = True
69
70 # Custom sidebar templates, filenames relative to this file.
71 html_sidebars = {
72 'index': 'indexsidebar.html',
73 }
74
75 # Additional templates that should be rendered to pages.
76 html_additional_pages = {
77 'download': 'download.html',
78 'index': 'indexcontent.html',
79 }
80
81 # Output an OpenSearch description file.
82 html_use_opensearch = 'http://docs.python.org/dev'
83
84 # Additional static files.
85 html_static_path = ['tools/sphinxext/static']
86
87 # Output file base name for HTML help builder.
0c3d1db @jdhardy Make so small IronPython-specific changes to the documentation.
jdhardy authored Feb 26, 2012
88 htmlhelp_basename = 'ironpython' + release.replace('.', '')
6e978f2 @jdhardy Add Python 2.7.2 documentation.
jdhardy authored Feb 25, 2012
89
90 # Split the index
91 html_split_index = True
92
93
94 # Options for LaTeX output
95 # ------------------------
96
97 # The paper size ('letter' or 'a4').
98 latex_paper_size = 'a4'
99
100 # The font size ('10pt', '11pt' or '12pt').
101 latex_font_size = '10pt'
102
103 # Grouping the document tree into LaTeX files. List of tuples
104 # (source start file, target name, title, author, document class [howto/manual]).
105 _stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor'
106 latex_documents = [
107 ('distutils/index', 'distutils.tex',
108 'Distributing Python Modules', _stdauthor, 'manual'),
109 ('documenting/index', 'documenting.tex',
110 'Documenting Python', 'Georg Brandl', 'manual'),
111 ('extending/index', 'extending.tex',
112 'Extending and Embedding Python', _stdauthor, 'manual'),
113 ('install/index', 'install.tex',
114 'Installing Python Modules', _stdauthor, 'manual'),
115 ('library/index', 'library.tex',
116 'The Python Library Reference', _stdauthor, 'manual'),
0c3d1db @jdhardy Make so small IronPython-specific changes to the documentation.
jdhardy authored Feb 26, 2012
117 ('net-api/index', 'net-api.tex',
118 'The Python/.NET API', 'IronPython Contributors', 'manual'),
6e978f2 @jdhardy Add Python 2.7.2 documentation.
jdhardy authored Feb 25, 2012
119 ('reference/index', 'reference.tex',
120 'The Python Language Reference', _stdauthor, 'manual'),
121 ('tutorial/index', 'tutorial.tex',
122 'Python Tutorial', _stdauthor, 'manual'),
123 ('using/index', 'using.tex',
124 'Python Setup and Usage', _stdauthor, 'manual'),
125 ('faq/index', 'faq.tex',
126 'Python Frequently Asked Questions', _stdauthor, 'manual'),
127 ('whatsnew/' + version, 'whatsnew.tex',
128 'What\'s New in Python', 'A. M. Kuchling', 'howto'),
129 ]
130 # Collect all HOWTOs individually
131 latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex',
132 '', _stdauthor, 'howto')
133 for fn in os.listdir('howto')
134 if fn.endswith('.rst') and fn != 'index.rst')
135
136 # Additional stuff for the LaTeX preamble.
137 latex_preamble = r'''
138 \authoraddress{
139 \strong{Python Software Foundation}\\
140 Email: \email{docs@python.org}
141 }
142 \let\Verbatim=\OriginalVerbatim
143 \let\endVerbatim=\endOriginalVerbatim
144 '''
145
146 # Documents to append as an appendix to all manuals.
147 latex_appendices = ['glossary', 'about', 'license', 'copyright']
148
149 # Get LaTeX to handle Unicode correctly
150 latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}'}
151
152 # Options for the coverage checker
153 # --------------------------------
154
155 # The coverage checker will ignore all modules/functions/classes whose names
156 # match any of the following regexes (using re.match).
157 coverage_ignore_modules = [
158 r'[T|t][k|K]',
159 r'Tix',
160 r'distutils.*',
161 ]
162
163 coverage_ignore_functions = [
164 'test($|_)',
165 ]
166
167 coverage_ignore_classes = [
168 ]
169
170 # Glob patterns for C source files for C API coverage, relative to this directory.
171 coverage_c_path = [
172 '../Include/*.h',
173 ]
174
175 # Regexes to find C items in the source files.
176 coverage_c_regexes = {
177 'cfunction': (r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'),
178 'data': (r'^PyAPI_DATA\(.*\)\s+([^_][\w_]+)'),
179 'macro': (r'^#define ([^_][\w_]+)\(.*\)[\s|\\]'),
180 }
181
182 # The coverage checker will ignore all C items whose names match these regexes
183 # (using re.match) -- the keys must be the same as in coverage_c_regexes.
184 coverage_ignore_c_items = {
185 # 'cfunction': [...]
186 }
Something went wrong with that request. Please try again.