##// END OF EJS Templates
2.0.0 beta 1
MinRK -
Show More
@@ -1,148 +1,148 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Release data for the IPython project."""
2 """Release data for the IPython project."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (c) 2008, IPython Development Team.
5 # Copyright (c) 2008, IPython Development Team.
6 # Copyright (c) 2001, Fernando Perez <fernando.perez@colorado.edu>
6 # Copyright (c) 2001, Fernando Perez <fernando.perez@colorado.edu>
7 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
7 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
8 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
8 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
9 #
9 #
10 # Distributed under the terms of the Modified BSD License.
10 # Distributed under the terms of the Modified BSD License.
11 #
11 #
12 # The full license is in the file COPYING.txt, distributed with this software.
12 # The full license is in the file COPYING.txt, distributed with this software.
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14
14
15 # Name of the package for release purposes. This is the name which labels
15 # Name of the package for release purposes. This is the name which labels
16 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
16 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
17 name = 'ipython'
17 name = 'ipython'
18
18
19 # IPython version information. An empty _version_extra corresponds to a full
19 # IPython version information. An empty _version_extra corresponds to a full
20 # release. 'dev' as a _version_extra string means this is a development
20 # release. 'dev' as a _version_extra string means this is a development
21 # version
21 # version
22 _version_major = 2
22 _version_major = 2
23 _version_minor = 0
23 _version_minor = 0
24 _version_patch = 0
24 _version_patch = 0
25 _version_extra = 'dev'
25 _version_extra = 'b1'
26 # _version_extra = 'rc1'
26 # _version_extra = 'rc1'
27 # _version_extra = '' # Uncomment this for full releases
27 # _version_extra = '' # Uncomment this for full releases
28
28
29 codename = 'Work in Progress'
29 codename = 'Work in Progress'
30
30
31 # Construct full version string from these.
31 # Construct full version string from these.
32 _ver = [_version_major, _version_minor, _version_patch]
32 _ver = [_version_major, _version_minor, _version_patch]
33
33
34 __version__ = '.'.join(map(str, _ver))
34 __version__ = '.'.join(map(str, _ver))
35 if _version_extra:
35 if _version_extra:
36 __version__ = __version__ + '-' + _version_extra
36 __version__ = __version__ + '-' + _version_extra
37
37
38 version = __version__ # backwards compatibility name
38 version = __version__ # backwards compatibility name
39 version_info = (_version_major, _version_minor, _version_patch, _version_extra)
39 version_info = (_version_major, _version_minor, _version_patch, _version_extra)
40
40
41 # Change this when incrementing the kernel protocol version
41 # Change this when incrementing the kernel protocol version
42 kernel_protocol_version_info = (4, 1)
42 kernel_protocol_version_info = (4, 1)
43
43
44 description = "IPython: Productive Interactive Computing"
44 description = "IPython: Productive Interactive Computing"
45
45
46 long_description = \
46 long_description = \
47 """
47 """
48 IPython provides a rich toolkit to help you make the most out of using Python
48 IPython provides a rich toolkit to help you make the most out of using Python
49 interactively. Its main components are:
49 interactively. Its main components are:
50
50
51 * Powerful interactive Python shells (terminal- and Qt-based).
51 * Powerful interactive Python shells (terminal- and Qt-based).
52 * A web-based interactive notebook environment with all shell features plus
52 * A web-based interactive notebook environment with all shell features plus
53 support for embedded figures, animations and rich media.
53 support for embedded figures, animations and rich media.
54 * Support for interactive data visualization and use of GUI toolkits.
54 * Support for interactive data visualization and use of GUI toolkits.
55 * Flexible, embeddable interpreters to load into your own projects.
55 * Flexible, embeddable interpreters to load into your own projects.
56 * A high-performance library for high level and interactive parallel computing
56 * A high-performance library for high level and interactive parallel computing
57 that works in multicore systems, clusters, supercomputing and cloud scenarios.
57 that works in multicore systems, clusters, supercomputing and cloud scenarios.
58
58
59 The enhanced interactive Python shells have the following main features:
59 The enhanced interactive Python shells have the following main features:
60
60
61 * Comprehensive object introspection.
61 * Comprehensive object introspection.
62
62
63 * Input history, persistent across sessions.
63 * Input history, persistent across sessions.
64
64
65 * Caching of output results during a session with automatically generated
65 * Caching of output results during a session with automatically generated
66 references.
66 references.
67
67
68 * Extensible tab completion, with support by default for completion of python
68 * Extensible tab completion, with support by default for completion of python
69 variables and keywords, filenames and function keywords.
69 variables and keywords, filenames and function keywords.
70
70
71 * Extensible system of 'magic' commands for controlling the environment and
71 * Extensible system of 'magic' commands for controlling the environment and
72 performing many tasks related either to IPython or the operating system.
72 performing many tasks related either to IPython or the operating system.
73
73
74 * A rich configuration system with easy switching between different setups
74 * A rich configuration system with easy switching between different setups
75 (simpler than changing $PYTHONSTARTUP environment variables every time).
75 (simpler than changing $PYTHONSTARTUP environment variables every time).
76
76
77 * Session logging and reloading.
77 * Session logging and reloading.
78
78
79 * Extensible syntax processing for special purpose situations.
79 * Extensible syntax processing for special purpose situations.
80
80
81 * Access to the system shell with user-extensible alias system.
81 * Access to the system shell with user-extensible alias system.
82
82
83 * Easily embeddable in other Python programs and GUIs.
83 * Easily embeddable in other Python programs and GUIs.
84
84
85 * Integrated access to the pdb debugger and the Python profiler.
85 * Integrated access to the pdb debugger and the Python profiler.
86
86
87 The parallel computing architecture has the following main features:
87 The parallel computing architecture has the following main features:
88
88
89 * Quickly parallelize Python code from an interactive Python/IPython session.
89 * Quickly parallelize Python code from an interactive Python/IPython session.
90
90
91 * A flexible and dynamic process model that be deployed on anything from
91 * A flexible and dynamic process model that be deployed on anything from
92 multicore workstations to supercomputers.
92 multicore workstations to supercomputers.
93
93
94 * An architecture that supports many different styles of parallelism, from
94 * An architecture that supports many different styles of parallelism, from
95 message passing to task farming.
95 message passing to task farming.
96
96
97 * Both blocking and fully asynchronous interfaces.
97 * Both blocking and fully asynchronous interfaces.
98
98
99 * High level APIs that enable many things to be parallelized in a few lines
99 * High level APIs that enable many things to be parallelized in a few lines
100 of code.
100 of code.
101
101
102 * Share live parallel jobs with other users securely.
102 * Share live parallel jobs with other users securely.
103
103
104 * Dynamically load balanced task farming system.
104 * Dynamically load balanced task farming system.
105
105
106 * Robust error handling in parallel code.
106 * Robust error handling in parallel code.
107
107
108 The latest development version is always available from IPython's `GitHub
108 The latest development version is always available from IPython's `GitHub
109 site <http://github.com/ipython>`_.
109 site <http://github.com/ipython>`_.
110 """
110 """
111
111
112 license = 'BSD'
112 license = 'BSD'
113
113
114 authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'),
114 authors = {'Fernando' : ('Fernando Perez','fperez.net@gmail.com'),
115 'Janko' : ('Janko Hauser','jhauser@zscout.de'),
115 'Janko' : ('Janko Hauser','jhauser@zscout.de'),
116 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'),
116 'Nathan' : ('Nathaniel Gray','n8gray@caltech.edu'),
117 'Ville' : ('Ville Vainio','vivainio@gmail.com'),
117 'Ville' : ('Ville Vainio','vivainio@gmail.com'),
118 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'),
118 'Brian' : ('Brian E Granger', 'ellisonbg@gmail.com'),
119 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com'),
119 'Min' : ('Min Ragan-Kelley', 'benjaminrk@gmail.com'),
120 'Thomas' : ('Thomas A. Kluyver', 'takowl@gmail.com'),
120 'Thomas' : ('Thomas A. Kluyver', 'takowl@gmail.com'),
121 'Jorgen' : ('Jorgen Stenarson', 'jorgen.stenarson@bostream.nu'),
121 'Jorgen' : ('Jorgen Stenarson', 'jorgen.stenarson@bostream.nu'),
122 'Matthias' : ('Matthias Bussonnier', 'bussonniermatthias@gmail.com'),
122 'Matthias' : ('Matthias Bussonnier', 'bussonniermatthias@gmail.com'),
123 }
123 }
124
124
125 author = 'The IPython Development Team'
125 author = 'The IPython Development Team'
126
126
127 author_email = 'ipython-dev@scipy.org'
127 author_email = 'ipython-dev@scipy.org'
128
128
129 url = 'http://ipython.org'
129 url = 'http://ipython.org'
130
130
131 download_url = 'https://github.com/ipython/ipython/downloads'
131 download_url = 'https://github.com/ipython/ipython/downloads'
132
132
133 platforms = ['Linux','Mac OSX','Windows XP/Vista/7/8']
133 platforms = ['Linux','Mac OSX','Windows XP/Vista/7/8']
134
134
135 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed',
135 keywords = ['Interactive','Interpreter','Shell','Parallel','Distributed',
136 'Web-based computing', 'Qt console', 'Embedding']
136 'Web-based computing', 'Qt console', 'Embedding']
137
137
138 classifiers = [
138 classifiers = [
139 'Intended Audience :: Developers',
139 'Intended Audience :: Developers',
140 'Intended Audience :: Science/Research',
140 'Intended Audience :: Science/Research',
141 'License :: OSI Approved :: BSD License',
141 'License :: OSI Approved :: BSD License',
142 'Programming Language :: Python',
142 'Programming Language :: Python',
143 'Programming Language :: Python :: 2',
143 'Programming Language :: Python :: 2',
144 'Programming Language :: Python :: 2.7',
144 'Programming Language :: Python :: 2.7',
145 'Programming Language :: Python :: 3',
145 'Programming Language :: Python :: 3',
146 'Topic :: System :: Distributed Computing',
146 'Topic :: System :: Distributed Computing',
147 'Topic :: System :: Shells'
147 'Topic :: System :: Shells'
148 ]
148 ]
@@ -1,246 +1,246 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 # We load the ipython release info into a dict by explicit execution
33 # We load the ipython release info into a dict by explicit execution
34 iprelease = {}
34 iprelease = {}
35 execfile('../../IPython/core/release.py',iprelease)
35 execfile('../../IPython/core/release.py',iprelease)
36
36
37 # General configuration
37 # General configuration
38 # ---------------------
38 # ---------------------
39
39
40 # Add any Sphinx extension module names here, as strings. They can be extensions
40 # Add any Sphinx extension module names here, as strings. They can be extensions
41 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
41 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
42 extensions = [
42 extensions = [
43 'matplotlib.sphinxext.mathmpl',
43 'matplotlib.sphinxext.mathmpl',
44 'matplotlib.sphinxext.only_directives',
44 'matplotlib.sphinxext.only_directives',
45 'matplotlib.sphinxext.plot_directive',
45 'matplotlib.sphinxext.plot_directive',
46 'sphinx.ext.autodoc',
46 'sphinx.ext.autodoc',
47 'sphinx.ext.autosummary',
47 'sphinx.ext.autosummary',
48 'sphinx.ext.doctest',
48 'sphinx.ext.doctest',
49 'sphinx.ext.inheritance_diagram',
49 'sphinx.ext.inheritance_diagram',
50 'sphinx.ext.intersphinx',
50 'sphinx.ext.intersphinx',
51 'IPython.sphinxext.ipython_console_highlighting',
51 'IPython.sphinxext.ipython_console_highlighting',
52 'IPython.sphinxext.ipython_directive',
52 'IPython.sphinxext.ipython_directive',
53 'numpydoc', # to preprocess docstrings
53 'numpydoc', # to preprocess docstrings
54 'github', # for easy GitHub links
54 'github', # for easy GitHub links
55 ]
55 ]
56
56
57 if ON_RTD:
57 if ON_RTD:
58 # Remove extensions not currently supported on RTD
58 # Remove extensions not currently supported on RTD
59 extensions.remove('matplotlib.sphinxext.only_directives')
59 extensions.remove('matplotlib.sphinxext.only_directives')
60 extensions.remove('matplotlib.sphinxext.mathmpl')
60 extensions.remove('matplotlib.sphinxext.mathmpl')
61 extensions.remove('matplotlib.sphinxext.plot_directive')
61 extensions.remove('matplotlib.sphinxext.plot_directive')
62 extensions.remove('IPython.sphinxext.ipython_directive')
62 extensions.remove('IPython.sphinxext.ipython_directive')
63 extensions.remove('IPython.sphinxext.ipython_console_highlighting')
63 extensions.remove('IPython.sphinxext.ipython_console_highlighting')
64
64
65 # Add any paths that contain templates here, relative to this directory.
65 # Add any paths that contain templates here, relative to this directory.
66 templates_path = ['_templates']
66 templates_path = ['_templates']
67
67
68 # The suffix of source filenames.
68 # The suffix of source filenames.
69 source_suffix = '.rst'
69 source_suffix = '.rst'
70
70
71 if iprelease['_version_extra']:
71 if iprelease['_version_extra']:
72 rst_prolog = """
72 rst_prolog = """
73 .. note::
73 .. note::
74
74
75 This documentation is for a development version of IPython. There may be
75 This documentation is for a development version of IPython. There may be
76 significant differences from the latest stable release (1.1.0).
76 significant differences from the latest stable release (1.2.1).
77
77
78 """
78 """
79
79
80 # The master toctree document.
80 # The master toctree document.
81 master_doc = 'index'
81 master_doc = 'index'
82
82
83 # General substitutions.
83 # General substitutions.
84 project = 'IPython'
84 project = 'IPython'
85 copyright = '2008, The IPython Development Team'
85 copyright = '2008, The IPython Development Team'
86
86
87 # ghissue config
87 # ghissue config
88 github_project_url = "https://github.com/ipython/ipython"
88 github_project_url = "https://github.com/ipython/ipython"
89
89
90 # numpydoc config
90 # numpydoc config
91 numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings
91 numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings
92 numpydoc_class_members_toctree = False
92 numpydoc_class_members_toctree = False
93
93
94 # The default replacements for |version| and |release|, also used in various
94 # The default replacements for |version| and |release|, also used in various
95 # other places throughout the built documents.
95 # other places throughout the built documents.
96 #
96 #
97 # The full version, including alpha/beta/rc tags.
97 # The full version, including alpha/beta/rc tags.
98 codename = iprelease['codename']
98 codename = iprelease['codename']
99 release = "%s: %s" % (iprelease['version'], codename)
99 release = "%s: %s" % (iprelease['version'], codename)
100 # Just the X.Y.Z part, no '-dev'
100 # Just the X.Y.Z part, no '-dev'
101 version = iprelease['version'].split('-', 1)[0]
101 version = iprelease['version'].split('-', 1)[0]
102
102
103
103
104 # There are two options for replacing |today|: either, you set today to some
104 # There are two options for replacing |today|: either, you set today to some
105 # non-false value, then it is used:
105 # non-false value, then it is used:
106 #today = ''
106 #today = ''
107 # Else, today_fmt is used as the format for a strftime call.
107 # Else, today_fmt is used as the format for a strftime call.
108 today_fmt = '%B %d, %Y'
108 today_fmt = '%B %d, %Y'
109
109
110 # List of documents that shouldn't be included in the build.
110 # List of documents that shouldn't be included in the build.
111 #unused_docs = []
111 #unused_docs = []
112
112
113 # List of directories, relative to source directories, that shouldn't be searched
113 # List of directories, relative to source directories, that shouldn't be searched
114 # for source files.
114 # for source files.
115 exclude_dirs = ['attic']
115 exclude_dirs = ['attic']
116
116
117 # If true, '()' will be appended to :func: etc. cross-reference text.
117 # If true, '()' will be appended to :func: etc. cross-reference text.
118 #add_function_parentheses = True
118 #add_function_parentheses = True
119
119
120 # If true, the current module name will be prepended to all description
120 # If true, the current module name will be prepended to all description
121 # unit titles (such as .. function::).
121 # unit titles (such as .. function::).
122 #add_module_names = True
122 #add_module_names = True
123
123
124 # If true, sectionauthor and moduleauthor directives will be shown in the
124 # If true, sectionauthor and moduleauthor directives will be shown in the
125 # output. They are ignored by default.
125 # output. They are ignored by default.
126 #show_authors = False
126 #show_authors = False
127
127
128 # The name of the Pygments (syntax highlighting) style to use.
128 # The name of the Pygments (syntax highlighting) style to use.
129 pygments_style = 'sphinx'
129 pygments_style = 'sphinx'
130
130
131
131
132 # Options for HTML output
132 # Options for HTML output
133 # -----------------------
133 # -----------------------
134
134
135 # The style sheet to use for HTML and HTML Help pages. A file of that name
135 # The style sheet to use for HTML and HTML Help pages. A file of that name
136 # must exist either in Sphinx' static/ path, or in one of the custom paths
136 # must exist either in Sphinx' static/ path, or in one of the custom paths
137 # given in html_static_path.
137 # given in html_static_path.
138 html_style = 'default.css'
138 html_style = 'default.css'
139
139
140 # The name for this set of Sphinx documents. If None, it defaults to
140 # The name for this set of Sphinx documents. If None, it defaults to
141 # "<project> v<release> documentation".
141 # "<project> v<release> documentation".
142 #html_title = None
142 #html_title = None
143
143
144 # The name of an image file (within the static path) to place at the top of
144 # The name of an image file (within the static path) to place at the top of
145 # the sidebar.
145 # the sidebar.
146 #html_logo = None
146 #html_logo = None
147
147
148 # Add any paths that contain custom static files (such as style sheets) here,
148 # Add any paths that contain custom static files (such as style sheets) here,
149 # relative to this directory. They are copied after the builtin static files,
149 # relative to this directory. They are copied after the builtin static files,
150 # so a file named "default.css" will overwrite the builtin "default.css".
150 # so a file named "default.css" will overwrite the builtin "default.css".
151 html_static_path = ['_static']
151 html_static_path = ['_static']
152
152
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154 # using the given strftime format.
154 # using the given strftime format.
155 html_last_updated_fmt = '%b %d, %Y'
155 html_last_updated_fmt = '%b %d, %Y'
156
156
157 # If true, SmartyPants will be used to convert quotes and dashes to
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
158 # typographically correct entities.
159 #html_use_smartypants = True
159 #html_use_smartypants = True
160
160
161 # Custom sidebar templates, maps document names to template names.
161 # Custom sidebar templates, maps document names to template names.
162 #html_sidebars = {}
162 #html_sidebars = {}
163
163
164 # Additional templates that should be rendered to pages, maps page names to
164 # Additional templates that should be rendered to pages, maps page names to
165 # template names.
165 # template names.
166 html_additional_pages = {
166 html_additional_pages = {
167 'interactive/htmlnotebook': 'htmlnotebook.html',
167 'interactive/htmlnotebook': 'htmlnotebook.html',
168 }
168 }
169
169
170 # If false, no module index is generated.
170 # If false, no module index is generated.
171 #html_use_modindex = True
171 #html_use_modindex = True
172
172
173 # If true, the reST sources are included in the HTML build as _sources/<name>.
173 # If true, the reST sources are included in the HTML build as _sources/<name>.
174 #html_copy_source = True
174 #html_copy_source = True
175
175
176 # If true, an OpenSearch description file will be output, and all pages will
176 # If true, an OpenSearch description file will be output, and all pages will
177 # contain a <link> tag referring to it. The value of this option must be the
177 # contain a <link> tag referring to it. The value of this option must be the
178 # base URL from which the finished HTML is served.
178 # base URL from which the finished HTML is served.
179 #html_use_opensearch = ''
179 #html_use_opensearch = ''
180
180
181 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
181 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
182 #html_file_suffix = ''
182 #html_file_suffix = ''
183
183
184 # Output file base name for HTML help builder.
184 # Output file base name for HTML help builder.
185 htmlhelp_basename = 'ipythondoc'
185 htmlhelp_basename = 'ipythondoc'
186
186
187 intersphinx_mapping = {'python': ('http://docs.python.org/2/', None)}
187 intersphinx_mapping = {'python': ('http://docs.python.org/2/', None)}
188
188
189 # Options for LaTeX output
189 # Options for LaTeX output
190 # ------------------------
190 # ------------------------
191
191
192 # The paper size ('letter' or 'a4').
192 # The paper size ('letter' or 'a4').
193 latex_paper_size = 'letter'
193 latex_paper_size = 'letter'
194
194
195 # The font size ('10pt', '11pt' or '12pt').
195 # The font size ('10pt', '11pt' or '12pt').
196 latex_font_size = '11pt'
196 latex_font_size = '11pt'
197
197
198 # Grouping the document tree into LaTeX files. List of tuples
198 # Grouping the document tree into LaTeX files. List of tuples
199 # (source start file, target name, title, author, document class [howto/manual]).
199 # (source start file, target name, title, author, document class [howto/manual]).
200
200
201 latex_documents = [
201 latex_documents = [
202 ('index', 'ipython.tex', 'IPython Documentation',
202 ('index', 'ipython.tex', 'IPython Documentation',
203 ur"""The IPython Development Team""", 'manual', True),
203 ur"""The IPython Development Team""", 'manual', True),
204 ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
204 ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
205 'Using IPython on Windows HPC Server 2008',
205 'Using IPython on Windows HPC Server 2008',
206 ur"Brian E. Granger", 'manual', True)
206 ur"Brian E. Granger", 'manual', True)
207 ]
207 ]
208
208
209 # The name of an image file (relative to this directory) to place at the top of
209 # The name of an image file (relative to this directory) to place at the top of
210 # the title page.
210 # the title page.
211 #latex_logo = None
211 #latex_logo = None
212
212
213 # For "manual" documents, if this is true, then toplevel headings are parts,
213 # For "manual" documents, if this is true, then toplevel headings are parts,
214 # not chapters.
214 # not chapters.
215 #latex_use_parts = False
215 #latex_use_parts = False
216
216
217 # Additional stuff for the LaTeX preamble.
217 # Additional stuff for the LaTeX preamble.
218 #latex_preamble = ''
218 #latex_preamble = ''
219
219
220 # Documents to append as an appendix to all manuals.
220 # Documents to append as an appendix to all manuals.
221 #latex_appendices = []
221 #latex_appendices = []
222
222
223 # If false, no module index is generated.
223 # If false, no module index is generated.
224 latex_use_modindex = True
224 latex_use_modindex = True
225
225
226
226
227 # Options for texinfo output
227 # Options for texinfo output
228 # --------------------------
228 # --------------------------
229
229
230 texinfo_documents = [
230 texinfo_documents = [
231 (master_doc, 'ipython', 'IPython Documentation',
231 (master_doc, 'ipython', 'IPython Documentation',
232 'The IPython Development Team',
232 'The IPython Development Team',
233 'IPython',
233 'IPython',
234 'IPython Documentation',
234 'IPython Documentation',
235 'Programming',
235 'Programming',
236 1),
236 1),
237 ]
237 ]
238
238
239 modindex_common_prefix = ['IPython.']
239 modindex_common_prefix = ['IPython.']
240
240
241
241
242 # Cleanup
242 # Cleanup
243 # -------
243 # -------
244 # delete release info to avoid pickling errors from sphinx
244 # delete release info to avoid pickling errors from sphinx
245
245
246 del iprelease
246 del iprelease
General Comments 0
You need to be logged in to leave comments. Login now