Skip to content
Snippets Groups Projects

Docs

Merged Docs
1 unresolved thread
Merged Mayr, Hannes requested to merge docs into dev
1 unresolved thread
6 files
+ 54
33
Compare changes
  • Side-by-side
  • Inline
Files
6
+ 15
10
"""
# 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:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
"""
# -- 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('../../plotid'))
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
from plotid import __version__, __author__ # noqa: E402
# -- Project information -----------------------------------------------------
project = 'PlotID'
copyright = '2022, Example Author'
author = 'Example Author'
project = 'plotID'
copyright = '2022, ' + __author__
author = __author__
# The full version, including alpha/beta/rc tags
release = '0.0.6'
release = __version__
# -- General configuration ---------------------------------------------------
@@ -31,6 +35,7 @@ release = '0.0.6'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.napoleon',
'autoapi.extension'
]
autoapi_type = 'python'
@@ -50,7 +55,7 @@ exclude_patterns = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# 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,
Loading