##// END OF EJS Templates
Merge pull request #3802 from ivanov/doc-to-rst...
Merge pull request #3802 from ivanov/doc-to-rst This renames our documentation files to .rst so that it renders nicely on GitHub The docs build just fine with these changes, it'd be good to get this in before any more changes are made to the docs

File last commit:

r11730:a4062b36
r11764:79d36b57 merge
Show More
conf.py
228 lines | 7.0 KiB | text/x-python | PythonLexer
# -*- coding: utf-8 -*-
#
# IPython documentation build configuration file.
# 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.
#
# 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.
import sys, os
ON_RTD = os.environ.get('READTHEDOCS', None) == 'True'
if ON_RTD:
# Mock the presence of matplotlib, which we don't have on RTD
# see
# http://read-the-docs.readthedocs.org/en/latest/faq.html
tags.add('rtd')
# 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.
sys.path.insert(0, os.path.abspath('../sphinxext'))
# Import support for ipython console session syntax highlighting
# (lives IPython's sphinxext subpackage)
from IPython.sphinxext import ipython_console_highlighting
# We load the ipython release info into a dict by explicit execution
iprelease = {}
execfile('../../IPython/core/release.py',iprelease)
# General configuration
# ---------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'matplotlib.sphinxext.mathmpl',
'matplotlib.sphinxext.only_directives',
'matplotlib.sphinxext.plot_directive',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.inheritance_diagram',
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'numpydoc', # to preprocess docstrings
'github', # for easy GitHub links
]
if ON_RTD:
# Remove extensions not currently supported on RTD
extensions.remove('matplotlib.sphinxext.only_directives')
extensions.remove('matplotlib.sphinxext.mathmpl')
extensions.remove('matplotlib.sphinxext.plot_directive')
extensions.remove('IPython.sphinxext.ipython_directive')
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General substitutions.
project = 'IPython'
copyright = '2008, The IPython Development Team'
# ghissue config
github_project_url = "https://github.com/ipython/ipython"
# 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.
release = iprelease['version']
# The short X.Y version.
version = '.'.join(release.split('.',2)[:2])
# 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 = []
# List of directories, relative to source directories, that shouldn't be searched
# for source files.
exclude_dirs = ['attic']
# 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'
# 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'
# 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
# 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.
#html_additional_pages = {}
# 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
# 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 = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'ipythondoc'
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
latex_font_size = '11pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
('index', 'ipython.tex', 'IPython Documentation',
ur"""The IPython Development Team""", 'manual', True),
('parallel/winhpc_index', 'winhpc_whitepaper.tex',
'Using IPython on Windows HPC Server 2008',
ur"Brian E. Granger", 'manual', True)
]
# 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
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
latex_use_modindex = True
# Options for texinfo output
# --------------------------
texinfo_documents = [
(master_doc, 'ipython', 'IPython Documentation',
'The IPython Development Team',
'IPython',
'IPython Documentation',
'Programming',
1),
]
# Cleanup
# -------
# delete release info to avoid pickling errors from sphinx
del iprelease