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