ESBO-ETC/docs/source/conf.py

71 lines
2.6 KiB
Python
Raw Normal View History

2020-05-23 17:40:05 +02:00
# 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('.'))
import sphinx_rtd_theme
# -- Project information -----------------------------------------------------
project = 'ESBO-ETC'
copyright = '2020, Lukas Klass, Philipp Maier'
author = 'Lukas Klass, Philipp Maier'
# The full version, including alpha/beta/rc tags
release = '1.0.0'
# -- 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.
2020-07-06 17:28:44 +02:00
extensions = ["sphinx_rtd_theme", "sphinx.ext.todo", "sphinx.ext.napoleon"]
2020-05-23 17:40:05 +02:00
# 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.
2020-05-26 22:10:21 +02:00
exclude_patterns = ['configuration/target.rst', 'configuration/common.rst', 'configuration/optical_components.rst',
2020-07-07 14:56:47 +02:00
'configuration/sensor.rst', 'developer/classes.rst']
2020-05-23 17:40:05 +02:00
# -- Options for HTML output -------------------------------------------------
2020-05-26 22:10:21 +02:00
html_show_sourcelink = False
2020-05-23 17:40:05 +02:00
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_logo = '_static/ESBOds_LOGO.png'
# 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".
2020-07-06 17:28:44 +02:00
html_static_path = ['_static']
# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = False