From 933c65797444a6e42d3ee0b7cfc91063e19c5eb2 Mon Sep 17 00:00:00 2001 From: Peter Hill Date: Thu, 22 Apr 2021 17:31:28 +0100 Subject: [PATCH] Always auto-generate the API docs --- docs/source/.gitignore | 1 + docs/source/api.rst | 5 +- docs/source/conf.py | 6 +- docs/source/easyvvuq.actions.rst | 53 ---------------- docs/source/easyvvuq.analysis.rst | 69 --------------------- docs/source/easyvvuq.comparison.rst | 29 --------- docs/source/easyvvuq.db.rst | 29 --------- docs/source/easyvvuq.decoders.rst | 45 -------------- docs/source/easyvvuq.encoders.rst | 69 --------------------- docs/source/easyvvuq.rst | 85 -------------------------- docs/source/easyvvuq.sampling.rst | 93 ----------------------------- docs/source/easyvvuq.utils.rst | 21 ------- docs/source/modules.rst | 7 --- 13 files changed, 10 insertions(+), 502 deletions(-) create mode 100644 docs/source/.gitignore delete mode 100644 docs/source/easyvvuq.actions.rst delete mode 100644 docs/source/easyvvuq.analysis.rst delete mode 100644 docs/source/easyvvuq.comparison.rst delete mode 100644 docs/source/easyvvuq.db.rst delete mode 100644 docs/source/easyvvuq.decoders.rst delete mode 100644 docs/source/easyvvuq.encoders.rst delete mode 100644 docs/source/easyvvuq.rst delete mode 100644 docs/source/easyvvuq.sampling.rst delete mode 100644 docs/source/easyvvuq.utils.rst delete mode 100644 docs/source/modules.rst diff --git a/docs/source/.gitignore b/docs/source/.gitignore new file mode 100644 index 000000000..791c6811d --- /dev/null +++ b/docs/source/.gitignore @@ -0,0 +1 @@ +_autodoc/ diff --git a/docs/source/api.rst b/docs/source/api.rst index 2c81a1cfa..46b066b6b 100644 --- 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 index 1ce8ec31e..b9b5a126c 100644 --- 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 deleted file mode 100644 index 9397707f2..000000000 --- a/docs/source/easyvvuq.actions.rst +++ /dev/null @@ -1,53 +0,0 @@ -easyvvuq.actions package -======================== - -Submodules ----------- - -easyvvuq.actions.action\_statuses module ----------------------------------------- - -.. automodule:: easyvvuq.actions.action_statuses - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.actions.base module ----------------------------- - -.. automodule:: easyvvuq.actions.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.actions.execute\_kubernetes module -------------------------------------------- - -.. automodule:: easyvvuq.actions.execute_kubernetes - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.actions.execute\_local module --------------------------------------- - -.. automodule:: easyvvuq.actions.execute_local - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.actions.execute\_slurm module --------------------------------------- - -.. automodule:: easyvvuq.actions.execute_slurm - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.actions - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.analysis.rst b/docs/source/easyvvuq.analysis.rst deleted file mode 100644 index 265f5c846..000000000 --- a/docs/source/easyvvuq.analysis.rst +++ /dev/null @@ -1,69 +0,0 @@ -easyvvuq.analysis package -========================= - -Submodules ----------- - -easyvvuq.analysis.base module ------------------------------ - -.. automodule:: easyvvuq.analysis.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.basic\_stats module -------------------------------------- - -.. automodule:: easyvvuq.analysis.basic_stats - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.ensemble\_boot module ---------------------------------------- - -.. automodule:: easyvvuq.analysis.ensemble_boot - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.gp\_analyse module ------------------------------------- - -.. automodule:: easyvvuq.analysis.gp_analyse - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.pce\_analysis module --------------------------------------- - -.. automodule:: easyvvuq.analysis.pce_analysis - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.qmc\_analysis module --------------------------------------- - -.. automodule:: easyvvuq.analysis.qmc_analysis - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.analysis.sc\_analysis module -------------------------------------- - -.. automodule:: easyvvuq.analysis.sc_analysis - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.analysis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.comparison.rst b/docs/source/easyvvuq.comparison.rst deleted file mode 100644 index ab864add0..000000000 --- a/docs/source/easyvvuq.comparison.rst +++ /dev/null @@ -1,29 +0,0 @@ -easyvvuq.comparison package -=========================== - -Submodules ----------- - -easyvvuq.comparison.base module -------------------------------- - -.. automodule:: easyvvuq.comparison.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.comparison.validate module ------------------------------------ - -.. automodule:: easyvvuq.comparison.validate - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.comparison - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.db.rst b/docs/source/easyvvuq.db.rst deleted file mode 100644 index 2625fafdb..000000000 --- a/docs/source/easyvvuq.db.rst +++ /dev/null @@ -1,29 +0,0 @@ -easyvvuq.db package -=================== - -Submodules ----------- - -easyvvuq.db.base module ------------------------ - -.. automodule:: easyvvuq.db.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.db.sql module ----------------------- - -.. automodule:: easyvvuq.db.sql - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.db - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.decoders.rst b/docs/source/easyvvuq.decoders.rst deleted file mode 100644 index 76a0ed631..000000000 --- a/docs/source/easyvvuq.decoders.rst +++ /dev/null @@ -1,45 +0,0 @@ -easyvvuq.decoders package -========================= - -Submodules ----------- - -easyvvuq.decoders.base module ------------------------------ - -.. automodule:: easyvvuq.decoders.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.decoders.json module ------------------------------ - -.. automodule:: easyvvuq.decoders.json - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.decoders.simple\_csv module ------------------------------------- - -.. automodule:: easyvvuq.decoders.simple_csv - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.decoders.yaml module ------------------------------ - -.. automodule:: easyvvuq.decoders.yaml - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.decoders - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.encoders.rst b/docs/source/easyvvuq.encoders.rst deleted file mode 100644 index ae6a538c3..000000000 --- a/docs/source/easyvvuq.encoders.rst +++ /dev/null @@ -1,69 +0,0 @@ -easyvvuq.encoders package -========================= - -Submodules ----------- - -easyvvuq.encoders.apply\_fixtures module ----------------------------------------- - -.. automodule:: easyvvuq.encoders.apply_fixtures - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.base module ------------------------------ - -.. automodule:: easyvvuq.encoders.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.copy\_encoder module --------------------------------------- - -.. automodule:: easyvvuq.encoders.copy_encoder - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.directory\_builder module -------------------------------------------- - -.. automodule:: easyvvuq.encoders.directory_builder - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.generic\_template module ------------------------------------------- - -.. automodule:: easyvvuq.encoders.generic_template - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.jinja\_encoder module ---------------------------------------- - -.. automodule:: easyvvuq.encoders.jinja_encoder - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.encoders.multiencoder module -------------------------------------- - -.. automodule:: easyvvuq.encoders.multiencoder - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.encoders - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.rst b/docs/source/easyvvuq.rst deleted file mode 100644 index 32baed7fd..000000000 --- a/docs/source/easyvvuq.rst +++ /dev/null @@ -1,85 +0,0 @@ -easyvvuq package -================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - easyvvuq.actions - easyvvuq.analysis - easyvvuq.collate - easyvvuq.comparison - easyvvuq.db - easyvvuq.decoders - easyvvuq.encoders - easyvvuq.sampling - easyvvuq.utils - -Submodules ----------- - -easyvvuq.base\_element module ------------------------------ - -.. automodule:: easyvvuq.base_element - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.campaign module ------------------------- - -.. automodule:: easyvvuq.campaign - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.campaign\_dask module ------------------------------- - -.. automodule:: easyvvuq.campaign_dask - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.constants module -------------------------- - -.. automodule:: easyvvuq.constants - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.data\_structs module ------------------------------ - -.. automodule:: easyvvuq.data_structs - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.params\_specification module -------------------------------------- - -.. automodule:: easyvvuq.params_specification - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.worker module ----------------------- - -.. automodule:: easyvvuq.worker - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.sampling.rst b/docs/source/easyvvuq.sampling.rst deleted file mode 100644 index 2bed51c54..000000000 --- a/docs/source/easyvvuq.sampling.rst +++ /dev/null @@ -1,93 +0,0 @@ -easyvvuq.sampling package -========================= - -Submodules ----------- - -easyvvuq.sampling.base module ------------------------------ - -.. automodule:: easyvvuq.sampling.base - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.empty module ------------------------------- - -.. automodule:: easyvvuq.sampling.empty - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.pce module ----------------------------- - -.. automodule:: easyvvuq.sampling.pce - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.qmc module ----------------------------- - -.. automodule:: easyvvuq.sampling.qmc - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.quasirandom module ------------------------------------- - -.. automodule:: easyvvuq.sampling.quasirandom - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.random module -------------------------------- - -.. automodule:: easyvvuq.sampling.random - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.replica\_sampler module ------------------------------------------ - -.. automodule:: easyvvuq.sampling.replica_sampler - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.sampler\_of\_samplers module ----------------------------------------------- - -.. automodule:: easyvvuq.sampling.sampler_of_samplers - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.stochastic\_collocation module ------------------------------------------------- - -.. automodule:: easyvvuq.sampling.stochastic_collocation - :members: - :undoc-members: - :show-inheritance: - -easyvvuq.sampling.sweep module ------------------------------- - -.. automodule:: easyvvuq.sampling.sweep - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.sampling - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/easyvvuq.utils.rst b/docs/source/easyvvuq.utils.rst deleted file mode 100644 index 032b7323b..000000000 --- a/docs/source/easyvvuq.utils.rst +++ /dev/null @@ -1,21 +0,0 @@ -easyvvuq.utils package -====================== - -Submodules ----------- - -easyvvuq.utils.helpers module ------------------------------ - -.. automodule:: easyvvuq.utils.helpers - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: easyvvuq.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index f85ebdec2..000000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -easyvvuq -======== - -.. toctree:: - :maxdepth: 4 - - easyvvuq