##// END OF EJS Templates
move ipython sphinx extensions into IPython.sphinxext
MinRK -
Show More
1 NO CONTENT: file renamed from docs/sphinxext/ipython_console_highlighting.py to IPython/sphinxext/ipython_console_highlighting.py
NO CONTENT: file renamed from docs/sphinxext/ipython_console_highlighting.py to IPython/sphinxext/ipython_console_highlighting.py
1 NO CONTENT: file renamed from docs/sphinxext/ipython_directive.py to IPython/sphinxext/ipython_directive.py
NO CONTENT: file renamed from docs/sphinxext/ipython_directive.py to IPython/sphinxext/ipython_directive.py
@@ -1,228 +1,228 b''
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
34 # in the sphinxext directory defined above)
34 # (lives IPython's sphinxext subpackage)
35 import ipython_console_highlighting
35 from IPython.sphinxext 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 'sphinx.ext.inheritance_diagram',
52 'sphinx.ext.inheritance_diagram',
53 'ipython_console_highlighting',
53 'IPython.sphinxext.ipython_console_highlighting',
54 'ipython_directive',
54 'IPython.sphinxext.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')
62 extensions.remove('matplotlib.sphinxext.mathmpl')
63 extensions.remove('matplotlib.sphinxext.plot_directive')
63 extensions.remove('matplotlib.sphinxext.plot_directive')
64 extensions.remove('ipython_directive')
64 extensions.remove('IPython.sphinxext.ipython_directive')
65
65
66 # Add any paths that contain templates here, relative to this directory.
66 # Add any paths that contain templates here, relative to this directory.
67 templates_path = ['_templates']
67 templates_path = ['_templates']
68
68
69 # The suffix of source filenames.
69 # The suffix of source filenames.
70 source_suffix = '.txt'
70 source_suffix = '.txt'
71
71
72 # The master toctree document.
72 # The master toctree document.
73 master_doc = 'index'
73 master_doc = 'index'
74
74
75 # General substitutions.
75 # General substitutions.
76 project = 'IPython'
76 project = 'IPython'
77 copyright = '2008, The IPython Development Team'
77 copyright = '2008, The IPython Development Team'
78
78
79 # ghissue config
79 # ghissue config
80 github_project_url = "https://github.com/ipython/ipython"
80 github_project_url = "https://github.com/ipython/ipython"
81
81
82 # The default replacements for |version| and |release|, also used in various
82 # The default replacements for |version| and |release|, also used in various
83 # other places throughout the built documents.
83 # other places throughout the built documents.
84 #
84 #
85 # The full version, including alpha/beta/rc tags.
85 # The full version, including alpha/beta/rc tags.
86 release = iprelease['version']
86 release = iprelease['version']
87 # The short X.Y version.
87 # The short X.Y version.
88 version = '.'.join(release.split('.',2)[:2])
88 version = '.'.join(release.split('.',2)[:2])
89
89
90
90
91 # 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
92 # non-false value, then it is used:
92 # non-false value, then it is used:
93 #today = ''
93 #today = ''
94 # 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.
95 today_fmt = '%B %d, %Y'
95 today_fmt = '%B %d, %Y'
96
96
97 # List of documents that shouldn't be included in the build.
97 # List of documents that shouldn't be included in the build.
98 #unused_docs = []
98 #unused_docs = []
99
99
100 # 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
101 # for source files.
101 # for source files.
102 exclude_dirs = ['attic']
102 exclude_dirs = ['attic']
103
103
104 # If true, '()' will be appended to :func: etc. cross-reference text.
104 # If true, '()' will be appended to :func: etc. cross-reference text.
105 #add_function_parentheses = True
105 #add_function_parentheses = True
106
106
107 # 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
108 # unit titles (such as .. function::).
108 # unit titles (such as .. function::).
109 #add_module_names = True
109 #add_module_names = True
110
110
111 # If true, sectionauthor and moduleauthor directives will be shown in the
111 # If true, sectionauthor and moduleauthor directives will be shown in the
112 # output. They are ignored by default.
112 # output. They are ignored by default.
113 #show_authors = False
113 #show_authors = False
114
114
115 # The name of the Pygments (syntax highlighting) style to use.
115 # The name of the Pygments (syntax highlighting) style to use.
116 pygments_style = 'sphinx'
116 pygments_style = 'sphinx'
117
117
118
118
119 # Options for HTML output
119 # Options for HTML output
120 # -----------------------
120 # -----------------------
121
121
122 # 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
123 # 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
124 # given in html_static_path.
124 # given in html_static_path.
125 html_style = 'default.css'
125 html_style = 'default.css'
126
126
127 # 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
128 # "<project> v<release> documentation".
128 # "<project> v<release> documentation".
129 #html_title = None
129 #html_title = None
130
130
131 # 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
132 # the sidebar.
132 # the sidebar.
133 #html_logo = None
133 #html_logo = None
134
134
135 # 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,
136 # 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,
137 # 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".
138 html_static_path = ['_static']
138 html_static_path = ['_static']
139
139
140 # 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,
141 # using the given strftime format.
141 # using the given strftime format.
142 html_last_updated_fmt = '%b %d, %Y'
142 html_last_updated_fmt = '%b %d, %Y'
143
143
144 # 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
145 # typographically correct entities.
145 # typographically correct entities.
146 #html_use_smartypants = True
146 #html_use_smartypants = True
147
147
148 # Custom sidebar templates, maps document names to template names.
148 # Custom sidebar templates, maps document names to template names.
149 #html_sidebars = {}
149 #html_sidebars = {}
150
150
151 # 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
152 # template names.
152 # template names.
153 #html_additional_pages = {}
153 #html_additional_pages = {}
154
154
155 # If false, no module index is generated.
155 # If false, no module index is generated.
156 #html_use_modindex = True
156 #html_use_modindex = True
157
157
158 # 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>.
159 #html_copy_source = True
159 #html_copy_source = True
160
160
161 # 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
162 # 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
163 # base URL from which the finished HTML is served.
163 # base URL from which the finished HTML is served.
164 #html_use_opensearch = ''
164 #html_use_opensearch = ''
165
165
166 # 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").
167 #html_file_suffix = ''
167 #html_file_suffix = ''
168
168
169 # Output file base name for HTML help builder.
169 # Output file base name for HTML help builder.
170 htmlhelp_basename = 'ipythondoc'
170 htmlhelp_basename = 'ipythondoc'
171
171
172
172
173 # Options for LaTeX output
173 # Options for LaTeX output
174 # ------------------------
174 # ------------------------
175
175
176 # The paper size ('letter' or 'a4').
176 # The paper size ('letter' or 'a4').
177 latex_paper_size = 'letter'
177 latex_paper_size = 'letter'
178
178
179 # The font size ('10pt', '11pt' or '12pt').
179 # The font size ('10pt', '11pt' or '12pt').
180 latex_font_size = '11pt'
180 latex_font_size = '11pt'
181
181
182 # Grouping the document tree into LaTeX files. List of tuples
182 # Grouping the document tree into LaTeX files. List of tuples
183 # (source start file, target name, title, author, document class [howto/manual]).
183 # (source start file, target name, title, author, document class [howto/manual]).
184
184
185 latex_documents = [
185 latex_documents = [
186 ('index', 'ipython.tex', 'IPython Documentation',
186 ('index', 'ipython.tex', 'IPython Documentation',
187 ur"""The IPython Development Team""", 'manual', True),
187 ur"""The IPython Development Team""", 'manual', True),
188 ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
188 ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
189 'Using IPython on Windows HPC Server 2008',
189 'Using IPython on Windows HPC Server 2008',
190 ur"Brian E. Granger", 'manual', True)
190 ur"Brian E. Granger", 'manual', True)
191 ]
191 ]
192
192
193 # 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
194 # the title page.
194 # the title page.
195 #latex_logo = None
195 #latex_logo = None
196
196
197 # 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,
198 # not chapters.
198 # not chapters.
199 #latex_use_parts = False
199 #latex_use_parts = False
200
200
201 # Additional stuff for the LaTeX preamble.
201 # Additional stuff for the LaTeX preamble.
202 #latex_preamble = ''
202 #latex_preamble = ''
203
203
204 # Documents to append as an appendix to all manuals.
204 # Documents to append as an appendix to all manuals.
205 #latex_appendices = []
205 #latex_appendices = []
206
206
207 # If false, no module index is generated.
207 # If false, no module index is generated.
208 latex_use_modindex = True
208 latex_use_modindex = True
209
209
210
210
211 # Options for texinfo output
211 # Options for texinfo output
212 # --------------------------
212 # --------------------------
213
213
214 texinfo_documents = [
214 texinfo_documents = [
215 (master_doc, 'ipython', 'IPython Documentation',
215 (master_doc, 'ipython', 'IPython Documentation',
216 'The IPython Development Team',
216 'The IPython Development Team',
217 'IPython',
217 'IPython',
218 'IPython Documentation',
218 'IPython Documentation',
219 'Programming',
219 'Programming',
220 1),
220 1),
221 ]
221 ]
222
222
223
223
224 # Cleanup
224 # Cleanup
225 # -------
225 # -------
226 # delete release info to avoid pickling errors from sphinx
226 # delete release info to avoid pickling errors from sphinx
227
227
228 del iprelease
228 del iprelease
General Comments 0
You need to be logged in to leave comments. Login now