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