| 1 |
# -*- coding: utf-8 -*- |
| 2 |
# |
| 3 |
# bqplot documentation build configuration file, created by |
| 4 |
# sphinx-quickstart on Thu Oct 8 15:45:33 2015. |
| 5 |
# |
| 6 |
# NOTE: This file has been edited manually from the auto-generated one from |
| 7 |
# sphinx. Do NOT delete and re-generate. If any changes from sphinx are |
| 8 |
# needed, generate a scratch one and merge by hand any new fields needed. |
| 9 |
# |
| 10 |
# This file is execfile()d with the current directory set to its |
| 11 |
# containing dir. |
| 12 |
# |
| 13 |
# Note that not all possible configuration values are present in this |
| 14 |
# autogenerated file. |
| 15 |
# |
| 16 |
# All configuration values have a default; values that are commented out |
| 17 |
# serve to show the default. |
| 18 |
|
| 19 |
import sys |
| 20 |
import os |
| 21 |
|
| 22 |
import sphinx_rtd_theme |
| 23 |
|
| 24 |
# If extensions (or modules to document with autodoc) are in another directory, |
| 25 |
# add these directories to sys.path here. If the directory is relative to the |
| 26 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 27 |
sys.path.insert(0, os.path.abspath('../../bqplot/')) |
| 28 |
|
| 29 |
# We load the bqplot release info into a dict by explicit execution |
| 30 |
_release = {} |
| 31 |
exec(compile(open('../../bqplot/_version.py').read(), '../../bqplot/_version.py', 'exec'), _release) |
| 32 |
|
| 33 |
# -- General configuration ------------------------------------------------ |
| 34 |
|
| 35 |
# If your documentation needs a minimal Sphinx version, state it here. |
| 36 |
#needs_sphinx = '1.0' |
| 37 |
|
| 38 |
# Add any Sphinx extension module names here, as strings. They can be |
| 39 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 40 |
# ones. |
| 41 |
extensions = [ |
| 42 |
'sphinx.ext.autodoc', |
| 43 |
'sphinx.ext.intersphinx', |
| 44 |
'sphinx.ext.autosummary', |
| 45 |
'sphinx.ext.viewcode', |
| 46 |
'sphinx.ext.napoleon', |
| 47 |
'jupyter_sphinx', |
| 48 |
'sphinx_thebe' |
| 49 |
] |
| 50 |
|
| 51 |
autosummary_generate = True |
| 52 |
|
| 53 |
# Add any paths that contain templates here, relative to this directory. |
| 54 |
templates_path = ['_templates'] |
| 55 |
|
| 56 |
# The suffix(es) of source filenames. |
| 57 |
source_suffix = '.rst' |
| 58 |
|
| 59 |
# Add dev disclaimer. |
| 60 |
if _release['version_info'][-1] == 'dev': |
| 61 |
rst_prolog = """ |
| 62 |
.. note:: |
| 63 |
|
| 64 |
This documentation is for a development version of bqplot. There may be |
| 65 |
significant differences from the latest stable release. |
| 66 |
|
| 67 |
""" |
| 68 |
|
| 69 |
# The master toctree document. |
| 70 |
master_doc = 'index' |
| 71 |
|
| 72 |
# General information about the project. |
| 73 |
project = u'bqplot' |
| 74 |
copyright = u'2015, Bloomberg LP' |
| 75 |
author = u'The BQplot Development Team' |
| 76 |
|
| 77 |
# The version info for the project you're documenting, acts as replacement for |
| 78 |
# |version| and |release|, also used in various other places throughout the |
| 79 |
# built documents. |
| 80 |
# |
| 81 |
# The short X.Y version. |
| 82 |
version = '.'.join(map(str, _release['version_info'][:2])) |
| 83 |
# The full version, including alpha/beta/rc tags. |
| 84 |
release = _release['__version__'] |
| 85 |
|
| 86 |
language = None |
| 87 |
|
| 88 |
# List of patterns, relative to source directory, that match files and |
| 89 |
# directories to ignore when looking for source files. |
| 90 |
exclude_patterns = [] |
| 91 |
|
| 92 |
# The name of the Pygments (syntax highlighting) style to use. |
| 93 |
pygments_style = 'sphinx' |
| 94 |
|
| 95 |
html_theme = "sphinx_rtd_theme" |
| 96 |
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 97 |
htmlhelp_basename = 'bqplotdoc' |
| 98 |
|
| 99 |
# -- Options for thebe --------------------------------------------- |
| 100 |
|
| 101 |
thebe_config = { |
| 102 |
"always_load": False, |
| 103 |
"selector": "div.jupyter_cell", |
| 104 |
"selector_output": "div.cell_output", |
| 105 |
"repository_url": "https://github.com/bqplot/bqplot", |
| 106 |
"repository_branch": "stable", |
| 107 |
} |
| 108 |
|
| 109 |
# -- Options for LaTeX output --------------------------------------------- |
| 110 |
|
| 111 |
latex_elements = {} |
| 112 |
|
| 113 |
# Grouping the document tree into LaTeX files. List of tuples |
| 114 |
# (source start file, target name, title, |
| 115 |
# author, documentclass [howto, manual, or own class]). |
| 116 |
latex_documents = [ |
| 117 |
('index', 'bqplot.tex', u'bqplot Documentation', |
| 118 |
u'Bloomberg LP', 'manual'), |
| 119 |
] |
| 120 |
|
| 121 |
# -- Options for manual page output --------------------------------------- |
| 122 |
|
| 123 |
# One entry per manual page. List of tuples |
| 124 |
# (source start file, name, description, authors, manual section). |
| 125 |
man_pages = [ |
| 126 |
('index', 'bqplot', u'bqplot Documentation', |
| 127 |
[u'Bloomberg LP'], 1) |
| 128 |
] |
| 129 |
|
| 130 |
# -- Options for Texinfo output ------------------------------------------- |
| 131 |
|
| 132 |
# Grouping the document tree into Texinfo files. List of tuples |
| 133 |
# (source start file, target name, title, author, |
| 134 |
# dir menu entry, description, category) |
| 135 |
texinfo_documents = [ |
| 136 |
('index', 'bqplot', u'bqplot Documentation', |
| 137 |
u'Bloomberg LP', 'bqplot', 'One line description of project.', |
| 138 |
'Miscellaneous'), |
| 139 |
] |