77a12a13 |
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
|
bc190a78 |
package_path = os.path.abspath("../..")
# Insert into sys.path so that we can import adaptive here
sys.path.insert(0, package_path)
# Insert into PYTHONPATH so that jupyter-sphinx will pick it up
os.environ["PYTHONPATH"] = ":".join((package_path, os.environ.get("PYTHONPATH", "")))
|
c60d8ca7 |
import adaptive # noqa: E402, isort:skip
|
77a12a13 |
# -- Project information -----------------------------------------------------
|
716dbce8 |
project = "adaptive"
|
97e986dd |
copyright = "2018-2019, Adaptive Authors"
|
716dbce8 |
author = "Adaptive Authors"
|
77a12a13 |
# The short X.Y version
version = adaptive.__version__
# The full version, including alpha/beta/rc tags
release = adaptive.__version__
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
|
716dbce8 |
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"jupyter_sphinx.execute",
"sphinx_fontawesome",
"m2r",
|
77a12a13 |
]
|
eef11f0b |
source_parsers = {}
|
c5179539 |
|
77a12a13 |
# Add any paths that contain templates here, relative to this directory.
|
716dbce8 |
templates_path = ["_templates"]
|
77a12a13 |
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
|
716dbce8 |
source_suffix = [".rst", ".md"]
# source_suffix = '.rst'
|
77a12a13 |
# The master toctree document.
|
716dbce8 |
master_doc = "index"
|
77a12a13 |
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
|
716dbce8 |
pygments_style = "sphinx"
|
77a12a13 |
|
97e986dd |
jupyter_sphinx_thebelab_config = {
"requestKernel": True,
"binderOptions": {"repo": "python-adaptive/adaptive"},
}
|
bc190a78 |
jupyter_execute_disable_stderr = True
|
97e986dd |
|
77a12a13 |
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
|
716dbce8 |
html_theme = "sphinx_rtd_theme"
|
77a12a13 |
|
76f7f858 |
|
77a12a13 |
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# 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".
|
716dbce8 |
html_static_path = ["_static"]
|
77a12a13 |
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
|
716dbce8 |
htmlhelp_basename = "adaptivedoc"
|
77a12a13 |
|
6fca822a |
|
77a12a13 |
# -- Extension configuration -------------------------------------------------
|
eef11f0b |
|
716dbce8 |
default_role = "autolink"
|
eef11f0b |
|
6fca822a |
intersphinx_mapping = {
|
716dbce8 |
"python": ("https://docs.python.org/3", None),
"distributed": ("https://distributed.readthedocs.io/en/stable/", None),
"holoviews": ("https://holoviews.org/", None),
"ipyparallel": ("https://ipyparallel.readthedocs.io/en/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
|
eef11f0b |
}
|
6fca822a |
|
76f7f858 |
def get_holoviews_js_css():
|
6fca822a |
from holoviews.plotting import Renderer
|
716dbce8 |
dependencies = {**Renderer.core_dependencies, **Renderer.extra_dependencies}
required = ["jQueryUI"] # require, jQuery, and underscore are added by sphinx
js = [url for name in required for url in dependencies[name].get("js", [])]
css = [url for name in required for url in dependencies[name].get("css", [])]
|
76f7f858 |
return js, css
|
6fca822a |
|
7a87ca1e |
# js, css = get_holoviews_js_css()
# html_context = {"holoviews_js_files": js} # used in source/_templates/layout.html
|
6cdd24e9 |
|
716dbce8 |
html_logo = "logo_docs.png"
|
ed4268cb |
|
6cdd24e9 |
|
76f7f858 |
def setup(app):
|
7a87ca1e |
# for url in css:
# app.add_stylesheet(url)
|
716dbce8 |
app.add_stylesheet("custom.css") # For the `live_info` widget
|