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