Merge pull request #1137 from stevenhua0320/c14

api workflow for build api documentation
regro · Jul 18, 2024 · 51bff54 · 51bff54
2 parents cdd397c + fe0d4bc
commit 51bff54
Show file tree

Hide file tree

Showing 54 changed files with 3,121 additions and 259 deletions.
diff --git a/doc/source/api/app.rst b/doc/source/api/app.rst
diff --git a/doc/source/api/basebuilder.rst b/doc/source/api/basebuilder.rst
diff --git a/doc/source/api/broker.rst b/doc/source/api/broker.rst
diff --git a/doc/source/api/builder.rst b/doc/source/api/builder.rst
diff --git a/doc/source/api/chained_db.rst b/doc/source/api/chained_db.rst
diff --git a/doc/source/api/commands.rst b/doc/source/api/commands.rst
diff --git a/doc/source/api/cvbuilder.rst b/doc/source/api/cvbuilder.rst
diff --git a/doc/source/api/database.rst b/doc/source/api/database.rst
diff --git a/doc/source/api/dates.rst b/doc/source/api/dates.rst
diff --git a/doc/source/api/deploy.rst b/doc/source/api/deploy.rst
diff --git a/doc/source/api/htmlbuilder.rst b/doc/source/api/htmlbuilder.rst
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
diff --git a/doc/source/api/interactive.rst b/doc/source/api/interactive.rst
diff --git a/doc/source/api/main.rst b/doc/source/api/main.rst
diff --git a/doc/source/api/regolith.builders.rst b/doc/source/api/regolith.builders.rst
@@ -0,0 +1,180 @@
+: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: