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