|
1 | 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 | 2 |
|
6 | 3 | # -- Project information ----------------------------------------------------- |
7 | | -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
8 | 4 |
|
9 | 5 | project = "prepmd" |
10 | 6 | copyright = "2026, CCPBioSim" |
11 | 7 | author = "CCPBioSim" |
12 | 8 |
|
13 | 9 | version = "1.0.0" |
| 10 | +release = "1.0.0" |
14 | 11 |
|
15 | 12 | # -- General configuration --------------------------------------------------- |
16 | | -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
17 | 13 |
|
18 | 14 | extensions = [ |
19 | 15 | "sphinx.ext.autosummary", |
20 | 16 | "sphinx.ext.autodoc", |
21 | 17 | "sphinx.ext.mathjax", |
22 | 18 | "sphinx.ext.viewcode", |
23 | 19 | "sphinx.ext.napoleon", |
24 | | - "sphinx.ext.intersphinx", |
25 | | - "sphinx.ext.extlinks", |
26 | 20 | "nbsphinx", |
27 | 21 | "sphinx_copybutton", |
28 | 22 | ] |
29 | 23 |
|
| 24 | +templates_path = ["_templates"] |
| 25 | +exclude_patterns = [] |
| 26 | + |
| 27 | +# -- Autosummary / autodoc --------------------------------------------------- |
| 28 | + |
30 | 29 | autosummary_generate = True |
31 | 30 |
|
| 31 | +autosummary_mock_imports = [ |
| 32 | + "openff", |
| 33 | + "openff.toolkit", |
| 34 | + "sklearn", |
| 35 | +] |
| 36 | + |
32 | 37 | autodoc_member_order = "bysource" |
33 | 38 | autodoc_typehints = "description" |
34 | 39 |
|
| 40 | +autodoc_mock_imports = [ |
| 41 | + "openff", |
| 42 | + "openff.toolkit", |
| 43 | + "sklearn", |
| 44 | +] |
| 45 | + |
| 46 | +# -- Napoleon docstring settings -------------------------------------------- |
| 47 | + |
35 | 48 | napoleon_google_docstring = False |
36 | 49 | napoleon_numpy_docstring = True |
37 | 50 | napoleon_use_param = False |
38 | 51 | napoleon_use_ivar = True |
39 | 52 |
|
40 | | -templates_path = ["_templates"] |
41 | | -exclude_patterns = [] |
42 | | - |
43 | | - |
44 | | - |
45 | 53 | # -- Options for HTML output ------------------------------------------------- |
46 | | -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
47 | 54 |
|
48 | 55 | html_theme = "furo" |
49 | 56 | html_static_path = ["_static"] |
0 commit comments