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