conf.py
269 lines
| 8.7 KiB
| text/x-python
|
PythonLexer
Ville M. Vainio
|
r1116 | # -*- coding: utf-8 -*- | ||
# | ||||
Fernando Perez
|
r1695 | # IPython documentation build configuration file. | ||
Fernando Perez
|
r1539 | |||
# NOTE: This file has been edited manually from the auto-generated one from | ||||
# sphinx. Do NOT delete and re-generate. If any changes from sphinx are | ||||
# needed, generate a scratch one and merge by hand any new fields needed. | ||||
Ville M. Vainio
|
r1116 | # | ||
# This file is execfile()d with the current directory set to its containing dir. | ||||
# | ||||
# The contents of this file are pickled, so don't put values in the namespace | ||||
# that aren't pickleable (module imports are okay, they're removed automatically). | ||||
# | ||||
# All configuration values have a default value; values that are commented out | ||||
# serve to show the default value. | ||||
Brian E Granger
|
r1256 | import sys, os | ||
Ville M. Vainio
|
r1116 | |||
Bussonnier Matthias
|
r8151 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' | ||
if ON_RTD: | ||||
# Mock the presence of matplotlib, which we don't have on RTD | ||||
# see | ||||
Matthias Bussonnier
|
r22289 | # http://read-the-docs.readthedocs.io/en/latest/faq.html | ||
Bussonnier Matthias
|
r8153 | tags.add('rtd') | ||
Min RK
|
r21589 | |||
# RTD doesn't use the Makefile, so re-run autogen_{things}.py here. | ||||
for name in ('config', 'api', 'magics'): | ||||
fname = 'autogen_{}.py'.format(name) | ||||
fpath = os.path.abspath(os.path.join('..', fname)) | ||||
with open(fpath) as f: | ||||
Min RK
|
r21592 | exec(compile(f.read(), fname, 'exec'), { | ||
'__file__': fpath, | ||||
'__name__': '__main__', | ||||
}) | ||||
Min RK
|
r21589 | |||
Brian E Granger
|
r1256 | # If your extensions are in another directory, add it here. If the directory | ||
# is relative to the documentation root, use os.path.abspath to make it | ||||
# absolute, like shown here. | ||||
MinRK
|
r3255 | sys.path.insert(0, os.path.abspath('../sphinxext')) | ||
Fernando Perez
|
r1695 | |||
Fernando Perez
|
r1539 | # We load the ipython release info into a dict by explicit execution | ||
iprelease = {} | ||||
Min RK
|
r20284 | exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease) | ||
Fernando Perez
|
r1539 | |||
Ville M. Vainio
|
r1116 | # General configuration | ||
# --------------------- | ||||
# Add any Sphinx extension module names here, as strings. They can be extensions | ||||
Brian E Granger
|
r1256 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
Brian Granger
|
r2275 | extensions = [ | ||
Matthias BUSSONNIER
|
r8420 | 'matplotlib.sphinxext.mathmpl', | ||
Brian Granger
|
r2275 | 'matplotlib.sphinxext.only_directives', | ||
Matthias BUSSONNIER
|
r8420 | 'matplotlib.sphinxext.plot_directive', | ||
Brian Granger
|
r2275 | 'sphinx.ext.autodoc', | ||
Thomas Kluyver
|
r13605 | 'sphinx.ext.autosummary', | ||
Brian Granger
|
r2275 | 'sphinx.ext.doctest', | ||
Julian Taylor
|
r10489 | 'sphinx.ext.inheritance_diagram', | ||
Thomas Kluyver
|
r13388 | 'sphinx.ext.intersphinx', | ||
MinRK
|
r11212 | 'IPython.sphinxext.ipython_console_highlighting', | ||
'IPython.sphinxext.ipython_directive', | ||||
Min RK
|
r21711 | 'sphinx.ext.napoleon', # to preprocess docstrings | ||
MinRK
|
r5280 | 'github', # for easy GitHub links | ||
Thomas Kluyver
|
r18184 | 'magics', | ||
Brian Granger
|
r2275 | ] | ||
Ville M. Vainio
|
r1116 | |||
Bussonnier Matthias
|
r8151 | if ON_RTD: | ||
# Remove extensions not currently supported on RTD | ||||
extensions.remove('matplotlib.sphinxext.only_directives') | ||||
Bussonnier Matthias
|
r8950 | extensions.remove('matplotlib.sphinxext.mathmpl') | ||
extensions.remove('matplotlib.sphinxext.plot_directive') | ||||
MinRK
|
r11212 | extensions.remove('IPython.sphinxext.ipython_directive') | ||
Matthias BUSSONNIER
|
r11811 | extensions.remove('IPython.sphinxext.ipython_console_highlighting') | ||
Bussonnier Matthias
|
r8151 | |||
Ville M. Vainio
|
r1116 | # Add any paths that contain templates here, relative to this directory. | ||
templates_path = ['_templates'] | ||||
# The suffix of source filenames. | ||||
Paul Ivanov
|
r11730 | source_suffix = '.rst' | ||
Ville M. Vainio
|
r1116 | |||
MinRK
|
r16176 | if iprelease['_version_extra'] == 'dev': | ||
Matthias BUSSONNIER
|
r11812 | rst_prolog = """ | ||
.. note:: | ||||
This documentation is for a development version of IPython. There may be | ||||
MinRK
|
r16176 | significant differences from the latest stable release. | ||
Matthias BUSSONNIER
|
r11812 | |||
""" | ||||
Ville M. Vainio
|
r1116 | # The master toctree document. | ||
Brian E Granger
|
r1256 | master_doc = 'index' | ||
Ville M. Vainio
|
r1116 | |||
# General substitutions. | ||||
project = 'IPython' | ||||
MinRK
|
r16176 | copyright = 'The IPython Development Team' | ||
Ville M. Vainio
|
r1116 | |||
MinRK
|
r5280 | # ghissue config | ||
github_project_url = "https://github.com/ipython/ipython" | ||||
Thomas Kluyver
|
r14000 | # numpydoc config | ||
numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings | ||||
numpydoc_class_members_toctree = False | ||||
Ville M. Vainio
|
r1116 | # The default replacements for |version| and |release|, also used in various | ||
# other places throughout the built documents. | ||||
# | ||||
# The full version, including alpha/beta/rc tags. | ||||
MinRK
|
r16025 | release = "%s" % iprelease['version'] | ||
MinRK
|
r11888 | # Just the X.Y.Z part, no '-dev' | ||
version = iprelease['version'].split('-', 1)[0] | ||||
Fernando Perez
|
r1539 | |||
Ville M. Vainio
|
r1116 | |||
# There are two options for replacing |today|: either, you set today to some | ||||
# non-false value, then it is used: | ||||
#today = '' | ||||
# Else, today_fmt is used as the format for a strftime call. | ||||
today_fmt = '%B %d, %Y' | ||||
# List of documents that shouldn't be included in the build. | ||||
#unused_docs = [] | ||||
Thomas Kluyver
|
r16161 | # Exclude these glob-style patterns when looking for source files. They are | ||
# relative to the source/ directory. | ||||
exclude_patterns = ['whatsnew/pr'] | ||||
Brian E Granger
|
r1256 | |||
Ville M. Vainio
|
r1116 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
#add_function_parentheses = True | ||||
# If true, the current module name will be prepended to all description | ||||
# unit titles (such as .. function::). | ||||
#add_module_names = True | ||||
# If true, sectionauthor and moduleauthor directives will be shown in the | ||||
# output. They are ignored by default. | ||||
#show_authors = False | ||||
# The name of the Pygments (syntax highlighting) style to use. | ||||
pygments_style = 'sphinx' | ||||
Thomas Kluyver
|
r17298 | # Set the default role so we can use `foo` instead of ``foo`` | ||
default_role = 'literal' | ||||
Ville M. Vainio
|
r1116 | |||
# Options for HTML output | ||||
# ----------------------- | ||||
# The style sheet to use for HTML and HTML Help pages. A file of that name | ||||
# must exist either in Sphinx' static/ path, or in one of the custom paths | ||||
# given in html_static_path. | ||||
html_style = 'default.css' | ||||
Matthias Bussonnier
|
r21714 | html_favicon = 'favicon.ico' | ||
Ville M. Vainio
|
r1116 | |||
Brian E Granger
|
r1256 | # The name for this set of Sphinx documents. If None, it defaults to | ||
# "<project> v<release> documentation". | ||||
#html_title = None | ||||
# The name of an image file (within the static path) to place at the top of | ||||
# the sidebar. | ||||
#html_logo = None | ||||
Ville M. Vainio
|
r1116 | # Add any paths that contain custom static files (such as style sheets) here, | ||
# relative to this directory. They are copied after the builtin static files, | ||||
# so a file named "default.css" will overwrite the builtin "default.css". | ||||
html_static_path = ['_static'] | ||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||||
# using the given strftime format. | ||||
html_last_updated_fmt = '%b %d, %Y' | ||||
# If true, SmartyPants will be used to convert quotes and dashes to | ||||
# typographically correct entities. | ||||
#html_use_smartypants = True | ||||
# Custom sidebar templates, maps document names to template names. | ||||
#html_sidebars = {} | ||||
# Additional templates that should be rendered to pages, maps page names to | ||||
# template names. | ||||
Paul Ivanov
|
r12098 | html_additional_pages = { | ||
MinRK
|
r15985 | 'interactive/htmlnotebook': 'notebook_redirect.html', | ||
'interactive/notebook': 'notebook_redirect.html', | ||||
'interactive/nbconvert': 'notebook_redirect.html', | ||||
'interactive/public_server': 'notebook_redirect.html', | ||||
Paul Ivanov
|
r12098 | } | ||
Ville M. Vainio
|
r1116 | |||
# If false, no module index is generated. | ||||
#html_use_modindex = True | ||||
# If true, the reST sources are included in the HTML build as _sources/<name>. | ||||
#html_copy_source = True | ||||
Brian E Granger
|
r1256 | # If true, an OpenSearch description file will be output, and all pages will | ||
# contain a <link> tag referring to it. The value of this option must be the | ||||
# base URL from which the finished HTML is served. | ||||
#html_use_opensearch = '' | ||||
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | ||||
#html_file_suffix = '' | ||||
Ville M. Vainio
|
r1116 | # Output file base name for HTML help builder. | ||
Fernando Perez
|
r1695 | htmlhelp_basename = 'ipythondoc' | ||
Ville M. Vainio
|
r1116 | |||
Min RK
|
r22251 | intersphinx_mapping = {'python': ('http://docs.python.org/3/', None), | ||
Thomas Kluyver
|
r21385 | 'rpy2': ('http://rpy.sourceforge.net/rpy2/doc-2.4/html/', None), | ||
Matthias Bussonnier
|
r22289 | 'traitlets': ('http://traitlets.readthedocs.io/en/latest/', None), | ||
'jupyterclient': ('http://jupyter-client.readthedocs.io/en/latest/', None), | ||||
'ipyparallel': ('http://ipyparallel.readthedocs.io/en/latest/', None), | ||||
'jupyter': ('http://jupyter.readthedocs.io/en/latest/', None), | ||||
Thomas Kluyver
|
r21385 | } | ||
Ville M. Vainio
|
r1116 | |||
# Options for LaTeX output | ||||
# ------------------------ | ||||
# The paper size ('letter' or 'a4'). | ||||
Brian E Granger
|
r1256 | latex_paper_size = 'letter' | ||
Ville M. Vainio
|
r1116 | |||
# The font size ('10pt', '11pt' or '12pt'). | ||||
Fernando Perez
|
r1525 | latex_font_size = '11pt' | ||
Ville M. Vainio
|
r1116 | |||
# Grouping the document tree into LaTeX files. List of tuples | ||||
# (source start file, target name, title, author, document class [howto/manual]). | ||||
Fernando Perez
|
r1525 | |||
Brian Granger
|
r2344 | latex_documents = [ | ||
('index', 'ipython.tex', 'IPython Documentation', | ||||
Min RK
|
r20277 | u"""The IPython Development Team""", 'manual', True), | ||
Brian Granger
|
r2344 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', | ||
'Using IPython on Windows HPC Server 2008', | ||||
Min RK
|
r20277 | u"Brian E. Granger", 'manual', True) | ||
Brian Granger
|
r2344 | ] | ||
Brian E Granger
|
r1256 | |||
# The name of an image file (relative to this directory) to place at the top of | ||||
# the title page. | ||||
#latex_logo = None | ||||
# For "manual" documents, if this is true, then toplevel headings are parts, | ||||
# not chapters. | ||||
#latex_use_parts = False | ||||
Ville M. Vainio
|
r1116 | |||
# Additional stuff for the LaTeX preamble. | ||||
Ville M. Vainio
|
r1185 | #latex_preamble = '' | ||
Ville M. Vainio
|
r1116 | |||
# Documents to append as an appendix to all manuals. | ||||
#latex_appendices = [] | ||||
# If false, no module index is generated. | ||||
Fernando Perez
|
r2339 | latex_use_modindex = True | ||
Fernando Perez
|
r1539 | |||
Takafumi Arakaki
|
r10009 | # Options for texinfo output | ||
# -------------------------- | ||||
texinfo_documents = [ | ||||
(master_doc, 'ipython', 'IPython Documentation', | ||||
'The IPython Development Team', | ||||
'IPython', | ||||
'IPython Documentation', | ||||
'Programming', | ||||
1), | ||||
] | ||||
Matthias BUSSONNIER
|
r13812 | modindex_common_prefix = ['IPython.'] | ||
Takafumi Arakaki
|
r10009 | |||
Fernando Perez
|
r1695 | # Cleanup | ||
# ------- | ||||
# delete release info to avoid pickling errors from sphinx | ||||
Fernando Perez
|
r1539 | del iprelease | ||