aboutsummaryrefslogtreecommitdiff
path: root/doc_generator/conf.py
blob: 676f03a693227a5e504d7b49993ddb8470df99d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sys
import os

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'qolab'
copyright = 'qolab developers'
author = 'Eugeniy Mikhailov'
release = '0.14'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    'autoapi.extension',
    # 'sphinx.ext.autodoc',
    # 'sphinx.ext.autosummary',
    # 'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
    'sphinx_rtd_theme']
# extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary']
autoapi_dirs = ['../qolab']
autoapi_keep_files = True

templates_path = ['_templates']
exclude_patterns = []

sys.path.insert(0, os.path.abspath('..'))
# autosummary_generate = True
autosummary_mock_imports = ['pandas', 'universal_tsdb', 'justpy', 'ue9', 'cachetools']

napoleon_google_docstring = True
napoleon_numpy_docstring = True


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# html_theme = 'alabaster'
# html_theme = 'sphinx_rtd_theme'
html_theme = 'furo'
html_static_path = ['_static']