Show More
@@ -1,263 +1,266 | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | # |
|
2 | # | |
3 | # IPython documentation build configuration file. |
|
3 | # IPython documentation build configuration file. | |
4 |
|
4 | |||
5 | # NOTE: This file has been edited manually from the auto-generated one from |
|
5 | # NOTE: This file has been edited manually from the auto-generated one from | |
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are |
|
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are | |
7 | # needed, generate a scratch one and merge by hand any new fields needed. |
|
7 | # needed, generate a scratch one and merge by hand any new fields needed. | |
8 |
|
8 | |||
9 | # |
|
9 | # | |
10 | # This file is execfile()d with the current directory set to its containing dir. |
|
10 | # This file is execfile()d with the current directory set to its containing dir. | |
11 | # |
|
11 | # | |
12 | # The contents of this file are pickled, so don't put values in the namespace |
|
12 | # The contents of this file are pickled, so don't put values in the namespace | |
13 | # that aren't pickleable (module imports are okay, they're removed automatically). |
|
13 | # that aren't pickleable (module imports are okay, they're removed automatically). | |
14 | # |
|
14 | # | |
15 | # All configuration values have a default value; values that are commented out |
|
15 | # All configuration values have a default value; values that are commented out | |
16 | # serve to show the default value. |
|
16 | # serve to show the default value. | |
17 |
|
17 | |||
18 | import sys, os |
|
18 | import sys, os | |
19 |
|
19 | |||
20 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' |
|
20 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' | |
21 |
|
21 | |||
22 | if ON_RTD: |
|
22 | if ON_RTD: | |
23 | # Mock the presence of matplotlib, which we don't have on RTD |
|
23 | # Mock the presence of matplotlib, which we don't have on RTD | |
24 | # see |
|
24 | # see | |
25 | # http://read-the-docs.readthedocs.org/en/latest/faq.html |
|
25 | # http://read-the-docs.readthedocs.org/en/latest/faq.html | |
26 | tags.add('rtd') |
|
26 | tags.add('rtd') | |
27 |
|
27 | |||
28 | # RTD doesn't use the Makefile, so re-run autogen_{things}.py here. |
|
28 | # RTD doesn't use the Makefile, so re-run autogen_{things}.py here. | |
29 | for name in ('config', 'api', 'magics'): |
|
29 | for name in ('config', 'api', 'magics'): | |
30 | fname = 'autogen_{}.py'.format(name) |
|
30 | fname = 'autogen_{}.py'.format(name) | |
31 | fpath = os.path.abspath(os.path.join('..', fname)) |
|
31 | fpath = os.path.abspath(os.path.join('..', fname)) | |
32 | with open(fpath) as f: |
|
32 | with open(fpath) as f: | |
33 |
exec(compile(f.read(), fname, 'exec'), { |
|
33 | exec(compile(f.read(), fname, 'exec'), { | |
|
34 | '__file__': fpath, | |||
|
35 | '__name__': '__main__', | |||
|
36 | }) | |||
34 |
|
37 | |||
35 | # If your extensions are in another directory, add it here. If the directory |
|
38 | # If your extensions are in another directory, add it here. If the directory | |
36 | # is relative to the documentation root, use os.path.abspath to make it |
|
39 | # is relative to the documentation root, use os.path.abspath to make it | |
37 | # absolute, like shown here. |
|
40 | # absolute, like shown here. | |
38 | sys.path.insert(0, os.path.abspath('../sphinxext')) |
|
41 | sys.path.insert(0, os.path.abspath('../sphinxext')) | |
39 |
|
42 | |||
40 | # We load the ipython release info into a dict by explicit execution |
|
43 | # We load the ipython release info into a dict by explicit execution | |
41 | iprelease = {} |
|
44 | iprelease = {} | |
42 | exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease) |
|
45 | exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease) | |
43 |
|
46 | |||
44 | # General configuration |
|
47 | # General configuration | |
45 | # --------------------- |
|
48 | # --------------------- | |
46 |
|
49 | |||
47 | # Add any Sphinx extension module names here, as strings. They can be extensions |
|
50 | # Add any Sphinx extension module names here, as strings. They can be extensions | |
48 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
51 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
49 | extensions = [ |
|
52 | extensions = [ | |
50 | 'matplotlib.sphinxext.mathmpl', |
|
53 | 'matplotlib.sphinxext.mathmpl', | |
51 | 'matplotlib.sphinxext.only_directives', |
|
54 | 'matplotlib.sphinxext.only_directives', | |
52 | 'matplotlib.sphinxext.plot_directive', |
|
55 | 'matplotlib.sphinxext.plot_directive', | |
53 | 'sphinx.ext.autodoc', |
|
56 | 'sphinx.ext.autodoc', | |
54 | 'sphinx.ext.autosummary', |
|
57 | 'sphinx.ext.autosummary', | |
55 | 'sphinx.ext.doctest', |
|
58 | 'sphinx.ext.doctest', | |
56 | 'sphinx.ext.inheritance_diagram', |
|
59 | 'sphinx.ext.inheritance_diagram', | |
57 | 'sphinx.ext.intersphinx', |
|
60 | 'sphinx.ext.intersphinx', | |
58 | 'IPython.sphinxext.ipython_console_highlighting', |
|
61 | 'IPython.sphinxext.ipython_console_highlighting', | |
59 | 'IPython.sphinxext.ipython_directive', |
|
62 | 'IPython.sphinxext.ipython_directive', | |
60 | 'numpydoc', # to preprocess docstrings |
|
63 | 'numpydoc', # to preprocess docstrings | |
61 | 'github', # for easy GitHub links |
|
64 | 'github', # for easy GitHub links | |
62 | 'magics', |
|
65 | 'magics', | |
63 | ] |
|
66 | ] | |
64 |
|
67 | |||
65 | if ON_RTD: |
|
68 | if ON_RTD: | |
66 | # Remove extensions not currently supported on RTD |
|
69 | # Remove extensions not currently supported on RTD | |
67 | extensions.remove('matplotlib.sphinxext.only_directives') |
|
70 | extensions.remove('matplotlib.sphinxext.only_directives') | |
68 | extensions.remove('matplotlib.sphinxext.mathmpl') |
|
71 | extensions.remove('matplotlib.sphinxext.mathmpl') | |
69 | extensions.remove('matplotlib.sphinxext.plot_directive') |
|
72 | extensions.remove('matplotlib.sphinxext.plot_directive') | |
70 | extensions.remove('IPython.sphinxext.ipython_directive') |
|
73 | extensions.remove('IPython.sphinxext.ipython_directive') | |
71 | extensions.remove('IPython.sphinxext.ipython_console_highlighting') |
|
74 | extensions.remove('IPython.sphinxext.ipython_console_highlighting') | |
72 |
|
75 | |||
73 | # Add any paths that contain templates here, relative to this directory. |
|
76 | # Add any paths that contain templates here, relative to this directory. | |
74 | templates_path = ['_templates'] |
|
77 | templates_path = ['_templates'] | |
75 |
|
78 | |||
76 | # The suffix of source filenames. |
|
79 | # The suffix of source filenames. | |
77 | source_suffix = '.rst' |
|
80 | source_suffix = '.rst' | |
78 |
|
81 | |||
79 | if iprelease['_version_extra'] == 'dev': |
|
82 | if iprelease['_version_extra'] == 'dev': | |
80 | rst_prolog = """ |
|
83 | rst_prolog = """ | |
81 | .. note:: |
|
84 | .. note:: | |
82 |
|
85 | |||
83 | This documentation is for a development version of IPython. There may be |
|
86 | This documentation is for a development version of IPython. There may be | |
84 | significant differences from the latest stable release. |
|
87 | significant differences from the latest stable release. | |
85 |
|
88 | |||
86 | """ |
|
89 | """ | |
87 |
|
90 | |||
88 | # The master toctree document. |
|
91 | # The master toctree document. | |
89 | master_doc = 'index' |
|
92 | master_doc = 'index' | |
90 |
|
93 | |||
91 | # General substitutions. |
|
94 | # General substitutions. | |
92 | project = 'IPython' |
|
95 | project = 'IPython' | |
93 | copyright = 'The IPython Development Team' |
|
96 | copyright = 'The IPython Development Team' | |
94 |
|
97 | |||
95 | # ghissue config |
|
98 | # ghissue config | |
96 | github_project_url = "https://github.com/ipython/ipython" |
|
99 | github_project_url = "https://github.com/ipython/ipython" | |
97 |
|
100 | |||
98 | # numpydoc config |
|
101 | # numpydoc config | |
99 | numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings |
|
102 | numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings | |
100 | numpydoc_class_members_toctree = False |
|
103 | numpydoc_class_members_toctree = False | |
101 |
|
104 | |||
102 | # The default replacements for |version| and |release|, also used in various |
|
105 | # The default replacements for |version| and |release|, also used in various | |
103 | # other places throughout the built documents. |
|
106 | # other places throughout the built documents. | |
104 | # |
|
107 | # | |
105 | # The full version, including alpha/beta/rc tags. |
|
108 | # The full version, including alpha/beta/rc tags. | |
106 | release = "%s" % iprelease['version'] |
|
109 | release = "%s" % iprelease['version'] | |
107 | # Just the X.Y.Z part, no '-dev' |
|
110 | # Just the X.Y.Z part, no '-dev' | |
108 | version = iprelease['version'].split('-', 1)[0] |
|
111 | version = iprelease['version'].split('-', 1)[0] | |
109 |
|
112 | |||
110 |
|
113 | |||
111 | # There are two options for replacing |today|: either, you set today to some |
|
114 | # There are two options for replacing |today|: either, you set today to some | |
112 | # non-false value, then it is used: |
|
115 | # non-false value, then it is used: | |
113 | #today = '' |
|
116 | #today = '' | |
114 | # Else, today_fmt is used as the format for a strftime call. |
|
117 | # Else, today_fmt is used as the format for a strftime call. | |
115 | today_fmt = '%B %d, %Y' |
|
118 | today_fmt = '%B %d, %Y' | |
116 |
|
119 | |||
117 | # List of documents that shouldn't be included in the build. |
|
120 | # List of documents that shouldn't be included in the build. | |
118 | #unused_docs = [] |
|
121 | #unused_docs = [] | |
119 |
|
122 | |||
120 | # Exclude these glob-style patterns when looking for source files. They are |
|
123 | # Exclude these glob-style patterns when looking for source files. They are | |
121 | # relative to the source/ directory. |
|
124 | # relative to the source/ directory. | |
122 | exclude_patterns = ['whatsnew/pr'] |
|
125 | exclude_patterns = ['whatsnew/pr'] | |
123 |
|
126 | |||
124 |
|
127 | |||
125 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
128 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
126 | #add_function_parentheses = True |
|
129 | #add_function_parentheses = True | |
127 |
|
130 | |||
128 | # If true, the current module name will be prepended to all description |
|
131 | # If true, the current module name will be prepended to all description | |
129 | # unit titles (such as .. function::). |
|
132 | # unit titles (such as .. function::). | |
130 | #add_module_names = True |
|
133 | #add_module_names = True | |
131 |
|
134 | |||
132 | # If true, sectionauthor and moduleauthor directives will be shown in the |
|
135 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
133 | # output. They are ignored by default. |
|
136 | # output. They are ignored by default. | |
134 | #show_authors = False |
|
137 | #show_authors = False | |
135 |
|
138 | |||
136 | # The name of the Pygments (syntax highlighting) style to use. |
|
139 | # The name of the Pygments (syntax highlighting) style to use. | |
137 | pygments_style = 'sphinx' |
|
140 | pygments_style = 'sphinx' | |
138 |
|
141 | |||
139 | # Set the default role so we can use `foo` instead of ``foo`` |
|
142 | # Set the default role so we can use `foo` instead of ``foo`` | |
140 | default_role = 'literal' |
|
143 | default_role = 'literal' | |
141 |
|
144 | |||
142 | # Options for HTML output |
|
145 | # Options for HTML output | |
143 | # ----------------------- |
|
146 | # ----------------------- | |
144 |
|
147 | |||
145 | # The style sheet to use for HTML and HTML Help pages. A file of that name |
|
148 | # The style sheet to use for HTML and HTML Help pages. A file of that name | |
146 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
149 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
147 | # given in html_static_path. |
|
150 | # given in html_static_path. | |
148 | html_style = 'default.css' |
|
151 | html_style = 'default.css' | |
149 |
|
152 | |||
150 | # The name for this set of Sphinx documents. If None, it defaults to |
|
153 | # The name for this set of Sphinx documents. If None, it defaults to | |
151 | # "<project> v<release> documentation". |
|
154 | # "<project> v<release> documentation". | |
152 | #html_title = None |
|
155 | #html_title = None | |
153 |
|
156 | |||
154 | # The name of an image file (within the static path) to place at the top of |
|
157 | # The name of an image file (within the static path) to place at the top of | |
155 | # the sidebar. |
|
158 | # the sidebar. | |
156 | #html_logo = None |
|
159 | #html_logo = None | |
157 |
|
160 | |||
158 | # Add any paths that contain custom static files (such as style sheets) here, |
|
161 | # Add any paths that contain custom static files (such as style sheets) here, | |
159 | # relative to this directory. They are copied after the builtin static files, |
|
162 | # relative to this directory. They are copied after the builtin static files, | |
160 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
163 | # so a file named "default.css" will overwrite the builtin "default.css". | |
161 | html_static_path = ['_static'] |
|
164 | html_static_path = ['_static'] | |
162 |
|
165 | |||
163 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
166 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
164 | # using the given strftime format. |
|
167 | # using the given strftime format. | |
165 | html_last_updated_fmt = '%b %d, %Y' |
|
168 | html_last_updated_fmt = '%b %d, %Y' | |
166 |
|
169 | |||
167 | # If true, SmartyPants will be used to convert quotes and dashes to |
|
170 | # If true, SmartyPants will be used to convert quotes and dashes to | |
168 | # typographically correct entities. |
|
171 | # typographically correct entities. | |
169 | #html_use_smartypants = True |
|
172 | #html_use_smartypants = True | |
170 |
|
173 | |||
171 | # Custom sidebar templates, maps document names to template names. |
|
174 | # Custom sidebar templates, maps document names to template names. | |
172 | #html_sidebars = {} |
|
175 | #html_sidebars = {} | |
173 |
|
176 | |||
174 | # Additional templates that should be rendered to pages, maps page names to |
|
177 | # Additional templates that should be rendered to pages, maps page names to | |
175 | # template names. |
|
178 | # template names. | |
176 | html_additional_pages = { |
|
179 | html_additional_pages = { | |
177 | 'interactive/htmlnotebook': 'notebook_redirect.html', |
|
180 | 'interactive/htmlnotebook': 'notebook_redirect.html', | |
178 | 'interactive/notebook': 'notebook_redirect.html', |
|
181 | 'interactive/notebook': 'notebook_redirect.html', | |
179 | 'interactive/nbconvert': 'notebook_redirect.html', |
|
182 | 'interactive/nbconvert': 'notebook_redirect.html', | |
180 | 'interactive/public_server': 'notebook_redirect.html', |
|
183 | 'interactive/public_server': 'notebook_redirect.html', | |
181 | } |
|
184 | } | |
182 |
|
185 | |||
183 | # If false, no module index is generated. |
|
186 | # If false, no module index is generated. | |
184 | #html_use_modindex = True |
|
187 | #html_use_modindex = True | |
185 |
|
188 | |||
186 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
189 | # If true, the reST sources are included in the HTML build as _sources/<name>. | |
187 | #html_copy_source = True |
|
190 | #html_copy_source = True | |
188 |
|
191 | |||
189 | # If true, an OpenSearch description file will be output, and all pages will |
|
192 | # If true, an OpenSearch description file will be output, and all pages will | |
190 | # contain a <link> tag referring to it. The value of this option must be the |
|
193 | # contain a <link> tag referring to it. The value of this option must be the | |
191 | # base URL from which the finished HTML is served. |
|
194 | # base URL from which the finished HTML is served. | |
192 | #html_use_opensearch = '' |
|
195 | #html_use_opensearch = '' | |
193 |
|
196 | |||
194 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
197 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
195 | #html_file_suffix = '' |
|
198 | #html_file_suffix = '' | |
196 |
|
199 | |||
197 | # Output file base name for HTML help builder. |
|
200 | # Output file base name for HTML help builder. | |
198 | htmlhelp_basename = 'ipythondoc' |
|
201 | htmlhelp_basename = 'ipythondoc' | |
199 |
|
202 | |||
200 | intersphinx_mapping = {'python': ('http://docs.python.org/2/', None), |
|
203 | intersphinx_mapping = {'python': ('http://docs.python.org/2/', None), | |
201 | 'rpy2': ('http://rpy.sourceforge.net/rpy2/doc-2.4/html/', None), |
|
204 | 'rpy2': ('http://rpy.sourceforge.net/rpy2/doc-2.4/html/', None), | |
202 | 'traitlets': ('http://traitlets.readthedocs.org/en/latest/', None), |
|
205 | 'traitlets': ('http://traitlets.readthedocs.org/en/latest/', None), | |
203 | 'jupyterclient': ('http://jupyter-client.readthedocs.org/en/latest/', None), |
|
206 | 'jupyterclient': ('http://jupyter-client.readthedocs.org/en/latest/', None), | |
204 | } |
|
207 | } | |
205 |
|
208 | |||
206 | # Options for LaTeX output |
|
209 | # Options for LaTeX output | |
207 | # ------------------------ |
|
210 | # ------------------------ | |
208 |
|
211 | |||
209 | # The paper size ('letter' or 'a4'). |
|
212 | # The paper size ('letter' or 'a4'). | |
210 | latex_paper_size = 'letter' |
|
213 | latex_paper_size = 'letter' | |
211 |
|
214 | |||
212 | # The font size ('10pt', '11pt' or '12pt'). |
|
215 | # The font size ('10pt', '11pt' or '12pt'). | |
213 | latex_font_size = '11pt' |
|
216 | latex_font_size = '11pt' | |
214 |
|
217 | |||
215 | # Grouping the document tree into LaTeX files. List of tuples |
|
218 | # Grouping the document tree into LaTeX files. List of tuples | |
216 | # (source start file, target name, title, author, document class [howto/manual]). |
|
219 | # (source start file, target name, title, author, document class [howto/manual]). | |
217 |
|
220 | |||
218 | latex_documents = [ |
|
221 | latex_documents = [ | |
219 | ('index', 'ipython.tex', 'IPython Documentation', |
|
222 | ('index', 'ipython.tex', 'IPython Documentation', | |
220 | u"""The IPython Development Team""", 'manual', True), |
|
223 | u"""The IPython Development Team""", 'manual', True), | |
221 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', |
|
224 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', | |
222 | 'Using IPython on Windows HPC Server 2008', |
|
225 | 'Using IPython on Windows HPC Server 2008', | |
223 | u"Brian E. Granger", 'manual', True) |
|
226 | u"Brian E. Granger", 'manual', True) | |
224 | ] |
|
227 | ] | |
225 |
|
228 | |||
226 | # The name of an image file (relative to this directory) to place at the top of |
|
229 | # The name of an image file (relative to this directory) to place at the top of | |
227 | # the title page. |
|
230 | # the title page. | |
228 | #latex_logo = None |
|
231 | #latex_logo = None | |
229 |
|
232 | |||
230 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|
233 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
231 | # not chapters. |
|
234 | # not chapters. | |
232 | #latex_use_parts = False |
|
235 | #latex_use_parts = False | |
233 |
|
236 | |||
234 | # Additional stuff for the LaTeX preamble. |
|
237 | # Additional stuff for the LaTeX preamble. | |
235 | #latex_preamble = '' |
|
238 | #latex_preamble = '' | |
236 |
|
239 | |||
237 | # Documents to append as an appendix to all manuals. |
|
240 | # Documents to append as an appendix to all manuals. | |
238 | #latex_appendices = [] |
|
241 | #latex_appendices = [] | |
239 |
|
242 | |||
240 | # If false, no module index is generated. |
|
243 | # If false, no module index is generated. | |
241 | latex_use_modindex = True |
|
244 | latex_use_modindex = True | |
242 |
|
245 | |||
243 |
|
246 | |||
244 | # Options for texinfo output |
|
247 | # Options for texinfo output | |
245 | # -------------------------- |
|
248 | # -------------------------- | |
246 |
|
249 | |||
247 | texinfo_documents = [ |
|
250 | texinfo_documents = [ | |
248 | (master_doc, 'ipython', 'IPython Documentation', |
|
251 | (master_doc, 'ipython', 'IPython Documentation', | |
249 | 'The IPython Development Team', |
|
252 | 'The IPython Development Team', | |
250 | 'IPython', |
|
253 | 'IPython', | |
251 | 'IPython Documentation', |
|
254 | 'IPython Documentation', | |
252 | 'Programming', |
|
255 | 'Programming', | |
253 | 1), |
|
256 | 1), | |
254 | ] |
|
257 | ] | |
255 |
|
258 | |||
256 | modindex_common_prefix = ['IPython.'] |
|
259 | modindex_common_prefix = ['IPython.'] | |
257 |
|
260 | |||
258 |
|
261 | |||
259 | # Cleanup |
|
262 | # Cleanup | |
260 | # ------- |
|
263 | # ------- | |
261 | # delete release info to avoid pickling errors from sphinx |
|
264 | # delete release info to avoid pickling errors from sphinx | |
262 |
|
265 | |||
263 | del iprelease |
|
266 | del iprelease |
General Comments 0
You need to be logged in to leave comments.
Login now