Merge pull request #335 from ZedThree/auto-docs

Always auto-generate the API docs
UCL-CCS · Apr 22, 2021 · d33da55 · d33da55
2 parents 6643171 + 933c657
commit d33da55
Show file tree

Hide file tree

Showing 13 changed files with 10 additions and 502 deletions.
diff --git a/docs/source/.gitignore b/docs/source/.gitignore
@@ -0,0 +1 @@
+_autodoc/
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -6,4 +6,7 @@ EasyVVUQ API Reference
 
 You will find the full documentation for the EasyVVUQ API below.
 
-.. include:: modules.rst
+.. toctree::
+   :maxdepth: 4
+
+   _autodoc/easyvvuq
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -14,6 +14,10 @@
 import sys
 sys.path.insert(0, os.path.abspath('../easyvvuq'))
 
+from sphinx.ext.apidoc import main as apidoc_main
+apidoc_main(["--force", "-o", "./_autodoc", "../../easyvvuq"])
+
+autodoc_mock_imports = ['dill']
 
 # -- Project information -----------------------------------------------------
 
@@ -32,7 +36,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc','sphinx.ext.napoleon', 'sphinx.ext.autosectionlabel']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.autosectionlabel', 'sphinx.ext.viewcode']
 
 autosectionlabel_prefix_document = True
 

diff --git a/docs/source/easyvvuq.actions.rst b/docs/source/easyvvuq.actions.rst
diff --git a/docs/source/easyvvuq.analysis.rst b/docs/source/easyvvuq.analysis.rst
diff --git a/docs/source/easyvvuq.comparison.rst b/docs/source/easyvvuq.comparison.rst
diff --git a/docs/source/easyvvuq.db.rst b/docs/source/easyvvuq.db.rst
diff --git a/docs/source/easyvvuq.decoders.rst b/docs/source/easyvvuq.decoders.rst
diff --git a/docs/source/easyvvuq.encoders.rst b/docs/source/easyvvuq.encoders.rst