Skip to content

Commit d33da55

Browse files
authored
Merge pull request #335 from ZedThree/auto-docs
Always auto-generate the API docs
2 parents 6643171 + 933c657 commit d33da55

13 files changed

+10
-502
lines changed

docs/source/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_autodoc/

docs/source/api.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@ EasyVVUQ API Reference
66

77
You will find the full documentation for the EasyVVUQ API below.
88

9-
.. include:: modules.rst
9+
.. toctree::
10+
:maxdepth: 4
11+
12+
_autodoc/easyvvuq

docs/source/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
import sys
1515
sys.path.insert(0, os.path.abspath('../easyvvuq'))
1616

17+
from sphinx.ext.apidoc import main as apidoc_main
18+
apidoc_main(["--force", "-o", "./_autodoc", "../../easyvvuq"])
19+
20+
autodoc_mock_imports = ['dill']
1721

1822
# -- Project information -----------------------------------------------------
1923

@@ -32,7 +36,7 @@
3236
# Add any Sphinx extension module names here, as strings. They can be
3337
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3438
# ones.
35-
extensions = ['sphinx.ext.autodoc','sphinx.ext.napoleon', 'sphinx.ext.autosectionlabel']
39+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.autosectionlabel', 'sphinx.ext.viewcode']
3640

3741
autosectionlabel_prefix_document = True
3842

docs/source/easyvvuq.actions.rst

-53
This file was deleted.

docs/source/easyvvuq.analysis.rst

-69
This file was deleted.

docs/source/easyvvuq.comparison.rst

-29
This file was deleted.

docs/source/easyvvuq.db.rst

-29
This file was deleted.

docs/source/easyvvuq.decoders.rst

-45
This file was deleted.

docs/source/easyvvuq.encoders.rst

-69
This file was deleted.

0 commit comments

Comments
 (0)