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