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