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