From eca121870dd040250ce299ae1319abe4832fffa4 Mon Sep 17 00:00:00 2001 From: stevenhua0320 Date: Thu, 18 Jul 2024 23:50:54 +0800 Subject: [PATCH] make auto_api to build api, and pre-commit them --- doc/source/api/app.rst | 10 - doc/source/api/basebuilder.rst | 10 - doc/source/api/broker.rst | 10 - doc/source/api/builder.rst | 10 - doc/source/api/chained_db.rst | 10 - doc/source/api/commands.rst | 10 - doc/source/api/cvbuilder.rst | 10 - doc/source/api/database.rst | 10 - doc/source/api/dates.rst | 10 - doc/source/api/deploy.rst | 10 - doc/source/api/htmlbuilder.rst | 10 - doc/source/api/index.rst | 35 --- doc/source/api/interactive.rst | 19 -- doc/source/api/main.rst | 10 - doc/source/api/regolith.builders.rst | 181 ++++++++++++++ doc/source/api/regolith.example_package.rst | 31 --- doc/source/api/regolith.helpers.rst | 261 ++++++++++++++++++++ doc/source/api/regolith.rst | 211 +++++++++++++++- doc/source/api/regolith.static.img.rst | 10 + doc/source/api/regolith.static.rst | 18 ++ doc/source/api/regolith.templates.rst | 10 + doc/source/api/runcontrol.rst | 10 - doc/source/api/tools.rst | 10 - doc/source/api/validators.rst | 10 - 24 files changed, 682 insertions(+), 244 deletions(-) delete mode 100644 doc/source/api/app.rst delete mode 100644 doc/source/api/basebuilder.rst delete mode 100644 doc/source/api/broker.rst delete mode 100644 doc/source/api/builder.rst delete mode 100644 doc/source/api/chained_db.rst delete mode 100644 doc/source/api/commands.rst delete mode 100644 doc/source/api/cvbuilder.rst delete mode 100644 doc/source/api/database.rst delete mode 100644 doc/source/api/dates.rst delete mode 100644 doc/source/api/deploy.rst delete mode 100644 doc/source/api/htmlbuilder.rst delete mode 100644 doc/source/api/index.rst delete mode 100644 doc/source/api/interactive.rst delete mode 100644 doc/source/api/main.rst create mode 100644 doc/source/api/regolith.builders.rst delete mode 100644 doc/source/api/regolith.example_package.rst create mode 100644 doc/source/api/regolith.helpers.rst create mode 100644 doc/source/api/regolith.static.img.rst create mode 100644 doc/source/api/regolith.static.rst create mode 100644 doc/source/api/regolith.templates.rst delete mode 100644 doc/source/api/runcontrol.rst delete mode 100644 doc/source/api/tools.rst delete mode 100644 doc/source/api/validators.rst diff --git a/doc/source/api/app.rst b/doc/source/api/app.rst deleted file mode 100644 index fc4ebeb42..000000000 --- a/doc/source/api/app.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_app: - -****************************************************** -Web Application (``regolith.app``) -****************************************************** - -.. automodule:: regolith.app - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/basebuilder.rst b/doc/source/api/basebuilder.rst deleted file mode 100644 index 810558de5..000000000 --- a/doc/source/api/basebuilder.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_basebuilder: - -****************************************************** -Builder Base Class (``regolith.builders.basebuilder``) -****************************************************** - -.. automodule:: regolith.builders.basebuilder - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/broker.rst b/doc/source/api/broker.rst deleted file mode 100644 index 0c8fe8bfb..000000000 --- a/doc/source/api/broker.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_broker: - -****************************************************** -Data Broker (``regolith.broker``) -****************************************************** - -.. automodule:: regolith.broker - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/builder.rst b/doc/source/api/builder.rst deleted file mode 100644 index bba1db8d6..000000000 --- a/doc/source/api/builder.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_builder: - -****************************************************** -Builders (``regolith.builder``) -****************************************************** - -.. automodule:: regolith.builder - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/chained_db.rst b/doc/source/api/chained_db.rst deleted file mode 100644 index 893329fe2..000000000 --- a/doc/source/api/chained_db.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_chained_db: - -****************************************************** -Base class for chaining DBs (``regolith.chained_db``) -****************************************************** - -.. automodule:: regolith.chained_db - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/commands.rst b/doc/source/api/commands.rst deleted file mode 100644 index 20c53266a..000000000 --- a/doc/source/api/commands.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_commands: - -****************************************************** -CLI Commands (``regolith.commands``) -****************************************************** - -.. automodule:: regolith.commands - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/cvbuilder.rst b/doc/source/api/cvbuilder.rst deleted file mode 100644 index 5c03f3f80..000000000 --- a/doc/source/api/cvbuilder.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_cvbuilder: - -****************************************************** -CV Builder (``regolith.builders.cvbuilder``) -****************************************************** - -.. automodule:: regolith.builders.cvbuilder - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/database.rst b/doc/source/api/database.rst deleted file mode 100644 index 1f38f7337..000000000 --- a/doc/source/api/database.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_database: - -****************************************************** -Database Interface Tools (``regolith.database``) -****************************************************** - -.. automodule:: regolith.database - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/dates.rst b/doc/source/api/dates.rst deleted file mode 100644 index 29558c0f0..000000000 --- a/doc/source/api/dates.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_dates: - -****************************************************** -Date Tools (``regolith.dates``) -****************************************************** - -.. automodule:: regolith.dates - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/deploy.rst b/doc/source/api/deploy.rst deleted file mode 100644 index 1175f5573..000000000 --- a/doc/source/api/deploy.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_deploy: - -****************************************************** -Deployment Tools (``regolith.deploy``) -****************************************************** - -.. automodule:: regolith.deploy - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/htmlbuilder.rst b/doc/source/api/htmlbuilder.rst deleted file mode 100644 index 5c812b199..000000000 --- a/doc/source/api/htmlbuilder.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_htmlbuilder: - -****************************************************** -Website Builder (``regolith.builders.htmlbuilder``) -****************************************************** - -.. automodule:: regolith.builders.htmlbuilder - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst deleted file mode 100644 index 94267b8da..000000000 --- a/doc/source/api/index.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _api: - -================= -Regolith API -================= -For those of you who want the gritty details. - -**Central Components:** - -.. toctree:: - :maxdepth: 1 - - runcontrol - database - builder - htmlbuilder - cvbuilder - deploy - basebuilder - chained_db - - -**Helpers:** - -.. toctree:: - :maxdepth: 1 - - tools - dates - validators - commands - main - app - broker - interactive diff --git a/doc/source/api/interactive.rst b/doc/source/api/interactive.rst deleted file mode 100644 index 4e64a8d2e..000000000 --- a/doc/source/api/interactive.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _regolith_interactive: - -****************************************************** -Interactive Sessions (``regolith.interact``) -****************************************************** - -Usage ------ - -.. code-block:: python - - from regolith.interact import * - cj = col['people']['CJ-Wright'] - active = [p for p in col['people'] if p.get('active', True)] - -.. automodule:: regolith.interact - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/main.rst b/doc/source/api/main.rst deleted file mode 100644 index d12b41da3..000000000 --- a/doc/source/api/main.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_main: - -****************************************************** -Command Line Interface (``regolith.main``) -****************************************************** - -.. automodule:: regolith.main - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/regolith.builders.rst b/doc/source/api/regolith.builders.rst new file mode 100644 index 000000000..7e8f52237 --- /dev/null +++ b/doc/source/api/regolith.builders.rst @@ -0,0 +1,181 @@ +:tocdepth: -1 + +regolith.builders package +========================= + +.. automodule:: regolith.builders + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +regolith.builders.reimbursementbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.reimbursementbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.preslistbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.preslistbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.beamplanbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.beamplanbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.manuscriptreviewbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.manuscriptreviewbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.figurebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.figurebuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.activitylogbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.activitylogbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.coabuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.coabuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.basebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.basebuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.proposalreviewbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.proposalreviewbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.grantreportbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.grantreportbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.postdocadbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.postdocadbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.publistbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.publistbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.internalhtmlbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.internalhtmlbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.formalletterbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.formalletterbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.gradebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.gradebuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.htmlbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.htmlbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.cvbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.cvbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.resumebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.resumebuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.readinglistsbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.readinglistsbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.cpbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.cpbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.appraisalbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.appraisalbuilder + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/regolith.example_package.rst b/doc/source/api/regolith.example_package.rst deleted file mode 100644 index e8fdb885f..000000000 --- a/doc/source/api/regolith.example_package.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _example_package documentation: - -|title| -======= - -.. |title| replace:: regolith.example_package package - -.. automodule:: regolith.example_package - :members: - :undoc-members: - :show-inheritance: - -|foo| ------ - -.. |foo| replace:: regolith.example_package.foo module - -.. automodule:: regolith.example_package.foo - :members: - :undoc-members: - :show-inheritance: - -|bar| ------ - -.. |bar| replace:: regolith.example_package.bar module - -.. automodule:: regolith.example_package.foo - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/regolith.helpers.rst b/doc/source/api/regolith.helpers.rst new file mode 100644 index 000000000..4dee58e4e --- /dev/null +++ b/doc/source/api/regolith.helpers.rst @@ -0,0 +1,261 @@ +:tocdepth: -1 + +regolith.helpers package +======================== + +.. automodule:: regolith.helpers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +regolith.helpers.l_contactshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_contactshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_finishprumhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_finishprumhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_todohelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.reimbstatushelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.reimbstatushelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_presentationhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_presentationhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_milestoneshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_milestoneshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.v_meetingshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.v_meetingshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_contacthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_contacthelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.basehelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.basehelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_logurlhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_logurlhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_expensehelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_expensehelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_proprevhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_proprevhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_todohelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_proposalhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_proposalhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_membershelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_membershelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_manurevhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_manurevhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_progressreporthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_progressreporthelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.f_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.f_todohelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_grppub_readlisthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_grppub_readlisthelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_projectahelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_projectahelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_generalhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_generalhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_grantshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_grantshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_currentappointmentshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_currentappointmentshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.l_abstracthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.l_abstracthelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.attestationshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.attestationshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.a_projectumhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.a_projectumhelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_todohelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.makeappointmentshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.makeappointmentshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_institutionshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_institutionshelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.hellohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.hellohelper + :members: + :undoc-members: + :show-inheritance: + +regolith.helpers.u_milestonehelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helpers.u_milestonehelper + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/regolith.rst b/doc/source/api/regolith.rst index 44aceb0e3..62a3828b2 100644 --- a/doc/source/api/regolith.rst +++ b/doc/source/api/regolith.rst @@ -1,9 +1,7 @@ :tocdepth: -1 -|title| -======= - -.. |title| replace:: regolith package +regolith package +================ .. automodule:: regolith :members: @@ -14,17 +12,212 @@ Subpackages ----------- .. toctree:: - regolith.example_package + :titlesonly: + + regolith.builders + regolith.static + regolith.templates + regolith.helpers Submodules ---------- -|module| --------- +regolith.fsclient module +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.fsclient + :members: + :undoc-members: + :show-inheritance: + +regolith.helper_connect_main module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helper_connect_main + :members: + :undoc-members: + :show-inheritance: + +regolith.stylers module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.stylers + :members: + :undoc-members: + :show-inheritance: + +regolith.sorters module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.sorters + :members: + :undoc-members: + :show-inheritance: + +regolith.helper_gui_main module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helper_gui_main + :members: + :undoc-members: + :show-inheritance: + +regolith.deploy module +^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.deploy + :members: + :undoc-members: + :show-inheritance: + +regolith.grader module +^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.grader + :members: + :undoc-members: + :show-inheritance: + +regolith.validators module +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.validators + :members: + :undoc-members: + :show-inheritance: + +regolith.runcontrol module +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.runcontrol + :members: + :undoc-members: + :show-inheritance: + +regolith.tools module +^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.tools + :members: + :undoc-members: + :show-inheritance: + +regolith.client_manager module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.client_manager + :members: + :undoc-members: + :show-inheritance: + +regolith.builder module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builder + :members: + :undoc-members: + :show-inheritance: + +regolith.classlist module +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.classlist + :members: + :undoc-members: + :show-inheritance: + +regolith.schemas module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.schemas + :members: + :undoc-members: + :show-inheritance: + +regolith.storage module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.storage + :members: + :undoc-members: + :show-inheritance: + +regolith.helper module +^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.helper + :members: + :undoc-members: + :show-inheritance: + +regolith.emailer module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.emailer + :members: + :undoc-members: + :show-inheritance: + +regolith.app module +^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.app + :members: + :undoc-members: + :show-inheritance: + +regolith.dates module +^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.dates + :members: + :undoc-members: + :show-inheritance: + +regolith.broker module +^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.broker + :members: + :undoc-members: + :show-inheritance: + +regolith.main module +^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.main + :members: + :undoc-members: + :show-inheritance: + +regolith.chained_db module +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.chained_db + :members: + :undoc-members: + :show-inheritance: + +regolith.interact module +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.interact + :members: + :undoc-members: + :show-inheritance: + +regolith.commands module +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.commands + :members: + :undoc-members: + :show-inheritance: -.. |module| replace:: regolith.example_submodule module +regolith.mongoclient module +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.example_submodule +.. automodule:: regolith.mongoclient :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/regolith.static.img.rst b/doc/source/api/regolith.static.img.rst new file mode 100644 index 000000000..972771915 --- /dev/null +++ b/doc/source/api/regolith.static.img.rst @@ -0,0 +1,10 @@ +:tocdepth: -1 + +regolith.static.img package +=========================== + +.. automodule:: regolith.static.img + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/regolith.static.rst b/doc/source/api/regolith.static.rst new file mode 100644 index 000000000..c292dcd76 --- /dev/null +++ b/doc/source/api/regolith.static.rst @@ -0,0 +1,18 @@ +:tocdepth: -1 + +regolith.static package +======================= + +.. automodule:: regolith.static + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + + regolith.static.img + diff --git a/doc/source/api/regolith.templates.rst b/doc/source/api/regolith.templates.rst new file mode 100644 index 000000000..41bfaf329 --- /dev/null +++ b/doc/source/api/regolith.templates.rst @@ -0,0 +1,10 @@ +:tocdepth: -1 + +regolith.templates package +========================== + +.. automodule:: regolith.templates + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/runcontrol.rst b/doc/source/api/runcontrol.rst deleted file mode 100644 index 32de42b1b..000000000 --- a/doc/source/api/runcontrol.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_runcontrol: - -****************************************************** -Run Controlers (``regolith.runcontrol``) -****************************************************** - -.. automodule:: regolith.runcontrol - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/tools.rst b/doc/source/api/tools.rst deleted file mode 100644 index c6b5524e5..000000000 --- a/doc/source/api/tools.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_tools: - -****************************************** -Tools (``regolith.tools``) -****************************************** - -.. automodule:: regolith.tools - :members: - :undoc-members: - :inherited-members: diff --git a/doc/source/api/validators.rst b/doc/source/api/validators.rst deleted file mode 100644 index 69a3df69b..000000000 --- a/doc/source/api/validators.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _regolith_validators: - -****************************************************** -Run Control Validators (``regolith.validators``) -****************************************************** - -.. automodule:: regolith.validators - :members: - :undoc-members: - :inherited-members: