86 lines
2.6 KiB
Python
86 lines
2.6 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains 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
|
|
sys.path.insert(0, os.path.abspath('../../pylib'))
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = False
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'pylib'
|
|
copyright = '2019, Daniel Weschke'
|
|
author = 'Daniel Weschke'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '2019.5.19'
|
|
|
|
|
|
# -- 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 = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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 = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'alabaster'
|
|
pygments_style = 'solarized-dark'
|
|
|
|
# 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']
|
|
|
|
html_context = {
|
|
'css_files': ['_static/custom.css'],
|
|
}
|
|
|
|
html_theme_options = {
|
|
'base_bg': '#292b2e',
|
|
'base_text': '#b2b2b2',
|
|
'body_text': '#b2b2b2',
|
|
'viewcode_target_bg': '#292b2e',
|
|
'pre_bg': '#25272c',
|
|
'code_text': '#b2b2b2',
|
|
'code_hover': 'transparent',
|
|
'sidebar_text': '#b2b2b2',
|
|
'sidebar_link': '#b2b2b2',
|
|
'sidebar_header': '#b2b2b2',
|
|
'link': '#5799b9',
|
|
'link_hover': '#ce537a',
|
|
'highlight_bg': '#444F65',
|
|
'xref_bg': 'transparent',
|
|
'xref_border': 'transparent',
|
|
'seealso_bg': '#25272c',
|
|
'seealso_border': '#2C2C2C',
|
|
}
|