diff --git a/doc/source/api/regolith.builders.rst b/doc/source/api/regolith.builders.rst index 2e1d3337d..1ce2163d7 100644 --- a/doc/source/api/regolith.builders.rst +++ b/doc/source/api/regolith.builders.rst @@ -11,18 +11,26 @@ regolith.builders package Submodules ---------- -regolith.builders.reimbursementbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.activitylogbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.reimbursementbuilder +.. automodule:: regolith.builders.activitylogbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.preslistbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.appraisalbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.preslistbuilder +.. automodule:: regolith.builders.appraisalbuilder + :members: + :undoc-members: + :show-inheritance: + +regolith.builders.basebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: regolith.builders.basebuilder :members: :undoc-members: :show-inheritance: @@ -35,50 +43,50 @@ regolith.builders.beamplanbuilder module :undoc-members: :show-inheritance: -regolith.builders.manuscriptreviewbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.coabuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.manuscriptreviewbuilder +.. automodule:: regolith.builders.coabuilder :members: :undoc-members: :show-inheritance: -regolith.builders.figurebuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.cpbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.figurebuilder +.. automodule:: regolith.builders.cpbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.activitylogbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.cvbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.activitylogbuilder +.. automodule:: regolith.builders.cvbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.coabuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.figurebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.coabuilder +.. automodule:: regolith.builders.figurebuilder :members: :undoc-members: :show-inheritance: -regolith.builders.basebuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.formalletterbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.basebuilder +.. automodule:: regolith.builders.formalletterbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.proposalreviewbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.gradebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.proposalreviewbuilder +.. automodule:: regolith.builders.gradebuilder :members: :undoc-members: :show-inheritance: @@ -91,18 +99,10 @@ regolith.builders.grantreportbuilder module :undoc-members: :show-inheritance: -regolith.builders.postdocadbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. automodule:: regolith.builders.postdocadbuilder - :members: - :undoc-members: - :show-inheritance: - -regolith.builders.publistbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.htmlbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.publistbuilder +.. automodule:: regolith.builders.htmlbuilder :members: :undoc-members: :show-inheritance: @@ -115,42 +115,42 @@ regolith.builders.internalhtmlbuilder module :undoc-members: :show-inheritance: -regolith.builders.formalletterbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.manuscriptreviewbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.formalletterbuilder +.. automodule:: regolith.builders.manuscriptreviewbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.gradebuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.postdocadbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.gradebuilder +.. automodule:: regolith.builders.postdocadbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.htmlbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.preslistbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.htmlbuilder +.. automodule:: regolith.builders.preslistbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.cvbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.proposalreviewbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.cvbuilder +.. automodule:: regolith.builders.proposalreviewbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.resumebuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.publistbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.resumebuilder +.. automodule:: regolith.builders.publistbuilder :members: :undoc-members: :show-inheritance: @@ -163,18 +163,18 @@ regolith.builders.readinglistsbuilder module :undoc-members: :show-inheritance: -regolith.builders.cpbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.reimbursementbuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.cpbuilder +.. automodule:: regolith.builders.reimbursementbuilder :members: :undoc-members: :show-inheritance: -regolith.builders.appraisalbuilder module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.builders.resumebuilder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builders.appraisalbuilder +.. automodule:: regolith.builders.resumebuilder :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/regolith.helpers.rst b/doc/source/api/regolith.helpers.rst index 4a9a2cddb..93ab76072 100644 --- a/doc/source/api/regolith.helpers.rst +++ b/doc/source/api/regolith.helpers.rst @@ -11,34 +11,34 @@ regolith.helpers package Submodules ---------- -regolith.helpers.l_contactshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.attestationshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_contactshelper +.. automodule:: regolith.helpers.attestationshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.u_finishprumhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.a_expensehelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_finishprumhelper +.. automodule:: regolith.helpers.a_expensehelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_todohelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.a_grppub_readlisthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_todohelper +.. automodule:: regolith.helpers.a_grppub_readlisthelper :members: :undoc-members: :show-inheritance: -regolith.helpers.reimbstatushelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.a_manurevhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.reimbstatushelper +.. automodule:: regolith.helpers.a_manurevhelper :members: :undoc-members: :show-inheritance: @@ -51,26 +51,34 @@ regolith.helpers.a_presentationhelper module :undoc-members: :show-inheritance: -regolith.helpers.l_milestoneshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.a_projectumhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_milestoneshelper +.. automodule:: regolith.helpers.a_projectumhelper :members: :undoc-members: :show-inheritance: -regolith.helpers.v_meetingshelper module +regolith.helpers.a_proposalhelper module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.v_meetingshelper +.. automodule:: regolith.helpers.a_proposalhelper :members: :undoc-members: :show-inheritance: -regolith.helpers.u_contacthelper module +regolith.helpers.a_proprevhelper module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_contacthelper +.. 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: @@ -83,82 +91,82 @@ regolith.helpers.basehelper module :undoc-members: :show-inheritance: -regolith.helpers.u_logurlhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.f_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_logurlhelper +.. automodule:: regolith.helpers.f_todohelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_expensehelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.hellohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_expensehelper +.. automodule:: regolith.helpers.hellohelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_proprevhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_abstracthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_proprevhelper +.. automodule:: regolith.helpers.l_abstracthelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_todohelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_contactshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_todohelper +.. automodule:: regolith.helpers.l_contactshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_proposalhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_currentappointmentshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_proposalhelper +.. automodule:: regolith.helpers.l_currentappointmentshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_membershelper module +regolith.helpers.l_generalhelper module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_membershelper +.. automodule:: regolith.helpers.l_generalhelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_manurevhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_grantshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_manurevhelper +.. automodule:: regolith.helpers.l_grantshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_progressreporthelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_membershelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_progressreporthelper +.. automodule:: regolith.helpers.l_membershelper :members: :undoc-members: :show-inheritance: -regolith.helpers.f_todohelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_milestoneshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.f_todohelper +.. automodule:: regolith.helpers.l_milestoneshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.a_grppub_readlisthelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_progressreporthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.a_grppub_readlisthelper +.. automodule:: regolith.helpers.l_progressreporthelper :members: :undoc-members: :show-inheritance: @@ -171,90 +179,82 @@ regolith.helpers.l_projectahelper module :undoc-members: :show-inheritance: -regolith.helpers.l_generalhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.l_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_generalhelper +.. automodule:: regolith.helpers.l_todohelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_grantshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.makeappointmentshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_grantshelper +.. automodule:: regolith.helpers.makeappointmentshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_currentappointmentshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.reimbstatushelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_currentappointmentshelper +.. automodule:: regolith.helpers.reimbstatushelper :members: :undoc-members: :show-inheritance: -regolith.helpers.l_abstracthelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.u_contacthelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.l_abstracthelper +.. automodule:: regolith.helpers.u_contacthelper :members: :undoc-members: :show-inheritance: -regolith.helpers.attestationshelper module +regolith.helpers.u_finishprumhelper module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.attestationshelper - :members: - :undoc-members: - :show-inheritance: - -regolith.helpers.a_projectumhelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. automodule:: regolith.helpers.a_projectumhelper +.. automodule:: regolith.helpers.u_finishprumhelper :members: :undoc-members: :show-inheritance: -regolith.helpers.u_todohelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.u_institutionshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_todohelper +.. automodule:: regolith.helpers.u_institutionshelper :members: :undoc-members: :show-inheritance: -regolith.helpers.makeappointmentshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.u_logurlhelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.makeappointmentshelper +.. automodule:: regolith.helpers.u_logurlhelper :members: :undoc-members: :show-inheritance: -regolith.helpers.u_institutionshelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.u_milestonehelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_institutionshelper +.. automodule:: regolith.helpers.u_milestonehelper :members: :undoc-members: :show-inheritance: -regolith.helpers.hellohelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.u_todohelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.hellohelper +.. automodule:: regolith.helpers.u_todohelper :members: :undoc-members: :show-inheritance: -regolith.helpers.u_milestonehelper module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helpers.v_meetingshelper module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helpers.u_milestonehelper +.. automodule:: regolith.helpers.v_meetingshelper :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/index.rst b/doc/source/api/regolith.rst similarity index 79% rename from doc/source/api/index.rst rename to doc/source/api/regolith.rst index 1f52ba354..dcd089448 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/regolith.rst @@ -1,217 +1,223 @@ -.. _api: +:tocdepth: -1 -================= -Regolith API -================= -For those of you who want the gritty details. +regolith package +================ + +.. automodule:: regolith + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- .. toctree:: - :maxdepth: 1 + :titlesonly: regolith.builders + regolith.helpers regolith.static regolith.templates - regolith.helpers -Other API usage +Submodules ---------- -regolith.fsclient -^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.app module +^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.fsclient +.. automodule:: regolith.app :members: :undoc-members: :show-inheritance: -regolith.helper_connect_main -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.broker module +^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helper_connect_main +.. automodule:: regolith.broker :members: :undoc-members: :show-inheritance: -regolith.stylers +regolith.builder module ^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.stylers +.. automodule:: regolith.builder :members: :undoc-members: :show-inheritance: -regolith.sorters -^^^^^^^^^^^^^^^^^^^^^^^ +regolith.chained_db module +^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.sorters +.. automodule:: regolith.chained_db :members: :undoc-members: :show-inheritance: -regolith.helper_gui_main -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.classlist module +^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helper_gui_main +.. automodule:: regolith.classlist :members: :undoc-members: :show-inheritance: -regolith.deploy -^^^^^^^^^^^^^^^^^^^^^^ +regolith.client_manager module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.deploy +.. automodule:: regolith.client_manager :members: :undoc-members: :show-inheritance: -regolith.grader -^^^^^^^^^^^^^^^^^^^^^^ +regolith.commands module +^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.grader +.. automodule:: regolith.commands :members: :undoc-members: :show-inheritance: -regolith.validators -^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.dates module +^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.validators +.. automodule:: regolith.dates :members: :undoc-members: :show-inheritance: -regolith.runcontrol -^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.deploy module +^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.runcontrol +.. automodule:: regolith.deploy :members: :undoc-members: :show-inheritance: -regolith.tools -^^^^^^^^^^^^^^^^^^^^^ +regolith.emailer module +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.tools +.. automodule:: regolith.emailer :members: :undoc-members: :show-inheritance: -regolith.client_manager -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.fsclient module +^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.client_manager +.. automodule:: regolith.fsclient :members: :undoc-members: :show-inheritance: -regolith.builder -^^^^^^^^^^^^^^^^^^^^^^^ +regolith.grader module +^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.builder +.. automodule:: regolith.grader :members: :undoc-members: :show-inheritance: -regolith.classlist -^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helper module +^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.classlist +.. automodule:: regolith.helper :members: :undoc-members: :show-inheritance: -regolith.schemas -^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helper_connect_main module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.schemas +.. automodule:: regolith.helper_connect_main :members: :undoc-members: :show-inheritance: -regolith.storage -^^^^^^^^^^^^^^^^^^^^^^^ +regolith.helper_gui_main module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.storage +.. automodule:: regolith.helper_gui_main :members: :undoc-members: :show-inheritance: -regolith.helper -^^^^^^^^^^^^^^^^^^^^^^ +regolith.interact module +^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.helper +.. automodule:: regolith.interact :members: :undoc-members: :show-inheritance: -regolith.emailer -^^^^^^^^^^^^^^^^^^^^^^^ +regolith.main module +^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.emailer +.. automodule:: regolith.main :members: :undoc-members: :show-inheritance: -regolith.app -^^^^^^^^^^^^^^^^^^^ +regolith.mongoclient module +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.app +.. automodule:: regolith.mongoclient :members: :undoc-members: :show-inheritance: -regolith.dates -^^^^^^^^^^^^^^^^^^^^^ +regolith.runcontrol module +^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.dates +.. automodule:: regolith.runcontrol :members: :undoc-members: :show-inheritance: -regolith.broker -^^^^^^^^^^^^^^^^^^^^^^ +regolith.schemas module +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.broker +.. automodule:: regolith.schemas :members: :undoc-members: :show-inheritance: -regolith.main -^^^^^^^^^^^^^^^^^^^^ +regolith.sorters module +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.main +.. automodule:: regolith.sorters :members: :undoc-members: :show-inheritance: -regolith.chained_db -^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.storage module +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.chained_db +.. automodule:: regolith.storage :members: :undoc-members: :show-inheritance: -regolith.interact -^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.stylers module +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.interact +.. automodule:: regolith.stylers :members: :undoc-members: :show-inheritance: -regolith.commands -^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.tools module +^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.commands +.. automodule:: regolith.tools :members: :undoc-members: :show-inheritance: -regolith.mongoclient -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +regolith.validators module +^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: regolith.mongoclient +.. automodule:: regolith.validators :members: :undoc-members: :show-inheritance: diff --git a/doc/source/collections/abstracts.rst b/doc/source/collections/abstracts.rst index 5ee5c924f..e69de29bb 100644 --- a/doc/source/collections/abstracts.rst +++ b/doc/source/collections/abstracts.rst @@ -1,56 +0,0 @@ -Abstracts -========= -Abstracts for a conference or workshop. This is generally public information - -Schema ------- -The following lists key names mapped to its type and meaning for each entry. - -:_id: string, Unique identifier for submission. This generally includes the author name and part of the title., required -:coauthors: string, names of coauthors, optional -:email: string, contact email for the author., required -:firstname: string, first name of the author., required -:institution: string, name of the institution, required -:lastname: string, last name of the author., required -:references: string, HTML string of reference for the abstract itself, optional -:text: string, HTML string of the abstract., required -:timestamp: string, The time when the abstract was submitted., required -:title: string, title of the presentation/paper., required - - -YAML Example ------------- - -.. code-block:: yaml - - Mouginot.Model: - coauthors: P.P.H. Wilson - email: mouginot@wisc.edu - firstname: Baptiste - institution: University of Wisconsin-Madison - lastname: Mouginot - references: '[1] B. MOUGINOT, “cyCLASS: CLASS models for Cyclus,”, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2 - (2016).' - text: The CLASS team has developed high quality predictors based on pre-trained - neural network... - timestamp: 5/5/2017 13:15:59 - title: Model Performance Analysis - - -JSON/Mongo Example ------------------- - -.. code-block:: json - - { - "_id": "Mouginot.Model", - "coauthors": "P.P.H. Wilson", - "email": "mouginot@wisc.edu", - "firstname": "Baptiste", - "institution": "University of Wisconsin-Madison", - "lastname": "Mouginot", - "references": "[1] B. MOUGINOT, \u201ccyCLASS: CLASS models for Cyclus,\u201d, Figshare, https://dx.doi.org/10.6084/m9.figshare.3468671.v2 (2016).", - "text": "The CLASS team has developed high quality predictors based on pre-trained neural network...", - "timestamp": "5/5/2017 13:15:59", - "title": "Model Performance Analysis" - } diff --git a/doc/source/conf.py b/doc/source/conf.py index 8e93f7f0e..0cbee7d73 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -59,11 +59,11 @@ # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = "index" +master_doc = "regolith" # General information about the project. project = "regolith" -copyright = "2015, Anthony Scopatz" +copyright = "2015, Anthony Scopatz, 2018-now Billinge group members" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the