Skip to content

Commit c954c13

Browse files
committed
docs: configure autodoc optional dependency mocks
1 parent 9a64901 commit c954c13

1 file changed

Lines changed: 20 additions & 13 deletions

File tree

docs/source/conf.py

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,56 @@
11
# 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
52

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

95
project = "prepmd"
106
copyright = "2026, CCPBioSim"
117
author = "CCPBioSim"
128

139
version = "1.0.0"
10+
release = "1.0.0"
1411

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

1814
extensions = [
1915
"sphinx.ext.autosummary",
2016
"sphinx.ext.autodoc",
2117
"sphinx.ext.mathjax",
2218
"sphinx.ext.viewcode",
2319
"sphinx.ext.napoleon",
24-
"sphinx.ext.intersphinx",
25-
"sphinx.ext.extlinks",
2620
"nbsphinx",
2721
"sphinx_copybutton",
2822
]
2923

24+
templates_path = ["_templates"]
25+
exclude_patterns = []
26+
27+
# -- Autosummary / autodoc ---------------------------------------------------
28+
3029
autosummary_generate = True
3130

31+
autosummary_mock_imports = [
32+
"openff",
33+
"openff.toolkit",
34+
"sklearn",
35+
]
36+
3237
autodoc_member_order = "bysource"
3338
autodoc_typehints = "description"
3439

40+
autodoc_mock_imports = [
41+
"openff",
42+
"openff.toolkit",
43+
"sklearn",
44+
]
45+
46+
# -- Napoleon docstring settings --------------------------------------------
47+
3548
napoleon_google_docstring = False
3649
napoleon_numpy_docstring = True
3750
napoleon_use_param = False
3851
napoleon_use_ivar = True
3952

40-
templates_path = ["_templates"]
41-
exclude_patterns = []
42-
43-
44-
4553
# -- Options for HTML output -------------------------------------------------
46-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4754

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

0 commit comments

Comments
 (0)