|
a |
|
b/docs/source/conf.py |
|
|
1 |
# Configuration file for the Sphinx documentation builder. |
|
|
2 |
# |
|
|
3 |
# For the full list of built-in configuration values, see the documentation: |
|
|
4 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
|
|
5 |
|
|
|
6 |
# -- Project information ----------------------------------------------------- |
|
|
7 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
|
|
8 |
|
|
|
9 |
import sys |
|
|
10 |
from pathlib import Path |
|
|
11 |
|
|
|
12 |
sys.path.insert(0, str(Path("../src").resolve())) |
|
|
13 |
|
|
|
14 |
import move |
|
|
15 |
|
|
|
16 |
project = "MOVE" |
|
|
17 |
copyright = "2022, Rasmussen Lab" |
|
|
18 |
author = "Rasmussen Lab" |
|
|
19 |
release = ".".join(map(str, move.__version__)) |
|
|
20 |
|
|
|
21 |
# -- General configuration --------------------------------------------------- |
|
|
22 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
|
|
23 |
|
|
|
24 |
extensions = [ |
|
|
25 |
"sphinx.ext.autodoc", |
|
|
26 |
"sphinx.ext.autosectionlabel", |
|
|
27 |
"sphinx.ext.autosummary", |
|
|
28 |
"sphinx.ext.napoleon", |
|
|
29 |
"sphinx_autodoc_typehints", |
|
|
30 |
"sphinxemoji.sphinxemoji", |
|
|
31 |
] |
|
|
32 |
|
|
|
33 |
templates_path = ["_templates"] |
|
|
34 |
exclude_patterns = [] |
|
|
35 |
|
|
|
36 |
# -- Options for HTML output ------------------------------------------------- |
|
|
37 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
|
|
38 |
|
|
|
39 |
html_theme = "sphinx_rtd_theme" |
|
|
40 |
html_theme_options = { |
|
|
41 |
"collapse_navigation": False, |
|
|
42 |
} |
|
|
43 |
html_static_path = [] |
|
|
44 |
|
|
|
45 |
# -- Napoleon settings -------------------------------------------------------- |
|
|
46 |
# https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#configuration |
|
|
47 |
|
|
|
48 |
napoleon_google_docstring = True |