Skip to content

Commit

Permalink
cookiecutting API doc workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
tinatn29 committed Dec 13, 2024
1 parent 054b004 commit 45baf38
Show file tree
Hide file tree
Showing 16 changed files with 315 additions and 287 deletions.
112 changes: 56 additions & 56 deletions doc/source/api/regolith.builders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,18 @@ regolith.builders package
Submodules
----------

regolith.builders.activitylogbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.activitylogbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.appraisalbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.reimbursementbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.appraisalbuilder
.. automodule:: regolith.builders.reimbursementbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.basebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.preslistbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.basebuilder
.. automodule:: regolith.builders.preslistbuilder
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -43,50 +35,50 @@ regolith.builders.beamplanbuilder module
:undoc-members:
:show-inheritance:

regolith.builders.coabuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.manuscriptreviewbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.coabuilder
.. automodule:: regolith.builders.manuscriptreviewbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.cpbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.figurebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.cpbuilder
.. automodule:: regolith.builders.figurebuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.cvbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.activitylogbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.cvbuilder
.. automodule:: regolith.builders.activitylogbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.figurebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.coabuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.figurebuilder
.. automodule:: regolith.builders.coabuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.formalletterbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.basebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.formalletterbuilder
.. automodule:: regolith.builders.basebuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.gradebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.proposalreviewbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.gradebuilder
.. automodule:: regolith.builders.proposalreviewbuilder
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -99,10 +91,18 @@ regolith.builders.grantreportbuilder module
:undoc-members:
:show-inheritance:

regolith.builders.htmlbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.postdocadbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.htmlbuilder
.. automodule:: regolith.builders.postdocadbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.publistbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.publistbuilder
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -115,42 +115,42 @@ regolith.builders.internalhtmlbuilder module
:undoc-members:
:show-inheritance:

regolith.builders.manuscriptreviewbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.formalletterbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.manuscriptreviewbuilder
.. automodule:: regolith.builders.formalletterbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.postdocadbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.gradebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.postdocadbuilder
.. automodule:: regolith.builders.gradebuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.preslistbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.htmlbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.preslistbuilder
.. automodule:: regolith.builders.htmlbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.proposalreviewbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.cvbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.proposalreviewbuilder
.. automodule:: regolith.builders.cvbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.publistbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.resumebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.publistbuilder
.. automodule:: regolith.builders.resumebuilder
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -163,18 +163,18 @@ regolith.builders.readinglistsbuilder module
:undoc-members:
:show-inheritance:

regolith.builders.reimbursementbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.cpbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.reimbursementbuilder
.. automodule:: regolith.builders.cpbuilder
:members:
:undoc-members:
:show-inheritance:

regolith.builders.resumebuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
regolith.builders.appraisalbuilder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: regolith.builders.resumebuilder
.. automodule:: regolith.builders.appraisalbuilder
:members:
:undoc-members:
:show-inheritance:
31 changes: 0 additions & 31 deletions doc/source/api/regolith.example_package.rst

This file was deleted.

Loading

0 comments on commit 45baf38

Please sign in to comment.