prepmd/docs/source/conf.py at 804574198cbcee666a97dbeb516536d251ecf3d2 · CCPBioSim/prepmd · GitHub

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Configuration file for the Sphinx documentation builder.

# -- Project information -----------------------------------------------------

project = "prepmd"
copyright = "2026, CCPBioSim"
author = "CCPBioSim"

version = "1.0.0"
release = "1.0.0"

# -- General configuration ---------------------------------------------------

extensions = [
    "sphinx.ext.autosummary",
    "sphinx.ext.autodoc",
    "sphinx.ext.mathjax",
    "sphinx.ext.viewcode",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
    "sphinx.ext.extlinks",
    "nbsphinx",
    "sphinx_copybutton",
]

autosummary_generate = True

autodoc_member_order = "bysource"
autodoc_typehints = "description"

templates_path = ["_templates"]
exclude_patterns = []

# -- Autosummary / autodoc ---------------------------------------------------

autosummary_generate = True

autosummary_mock_imports = [
    "openff",
    "openff.toolkit",
    "sklearn",
]

autodoc_member_order = "bysource"
autodoc_typehints = "description"

autodoc_mock_imports = [
    "openff",
    "openff.toolkit",
    "sklearn",
]

# -- Napoleon docstring settings --------------------------------------------

napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_param = False
napoleon_use_ivar = True

templates_path = ["_templates"]
exclude_patterns = []


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

html_theme = "furo"
html_static_path = ["_static"]