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