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