diff --git a/docs/source/api.rst b/docs/source/api.rst index acae9b2..6627f8c 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -1,11 +1,12 @@ +:orphan: + API === -.. autosummary:: - :toctree: generated +The API reference below contains detailed documentation for SimPM's +modules and public interfaces. + +.. toctree:: + :maxdepth: 1 - simpm - simpm.dashboard - simpm.des - simpm.dist - simpm.log_cfg + api_reference/index diff --git a/docs/source/generated/simpm.dashboard.rst b/docs/source/generated/simpm.dashboard.rst deleted file mode 100644 index 4ed673a..0000000 --- a/docs/source/generated/simpm.dashboard.rst +++ /dev/null @@ -1,11 +0,0 @@ -simpm.dashboard -=============== - -.. automodule:: simpm.dashboard - - .. rubric:: Functions - - .. autosummary:: - - build_app - run_post_dashboard diff --git a/docs/source/generated/simpm.des.rst b/docs/source/generated/simpm.des.rst deleted file mode 100644 index 8174376..0000000 --- a/docs/source/generated/simpm.des.rst +++ /dev/null @@ -1,43 +0,0 @@ -simpm.des -========= - -.. automodule:: simpm.des - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Entity - Environment - GeneralResource - PreemptiveRequest - PreemptiveResource - PriorityRequest - PriorityResource - Request - Resource - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - Preempted - - - - - diff --git a/docs/source/generated/simpm.dist.rst b/docs/source/generated/simpm.dist.rst deleted file mode 100644 index aa56423..0000000 --- a/docs/source/generated/simpm.dist.rst +++ /dev/null @@ -1,54 +0,0 @@ -simpm.dist -========== - -.. automodule:: simpm.dist - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - fit - fit_beta - fit_expon - fit_norm - fit_trapz - fit_triang - make_beta - make_expon - make_norm - make_trapz - make_triang - make_uniform - - - - - - .. rubric:: Classes - - .. autosummary:: - - FitResult - beta - distribution - empirical - expon - norm - trapz - triang - uniform - - - - - - - - - diff --git a/docs/source/generated/simpm.log_cfg.rst b/docs/source/generated/simpm.log_cfg.rst deleted file mode 100644 index 7b88069..0000000 --- a/docs/source/generated/simpm.log_cfg.rst +++ /dev/null @@ -1,35 +0,0 @@ -simpm.log\_cfg -============== - -.. automodule:: simpm.log_cfg - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - log_config - - - - - - .. rubric:: Classes - - .. autosummary:: - - LogConfig - - - - - - - - - diff --git a/docs/source/generated/simpm.rst b/docs/source/generated/simpm.rst deleted file mode 100644 index cd7cd4e..0000000 --- a/docs/source/generated/simpm.rst +++ /dev/null @@ -1,23 +0,0 @@ -simpm -===== - -.. automodule:: simpm - - - - - - - - - - - - - - - - - - -