From b595621482ae43998ae0fb9447a24008c5b1ca2b Mon Sep 17 00:00:00 2001 From: Daniel K Lyons <dlyons@nrao.edu> Date: Thu, 16 Sep 2021 09:01:26 -0600 Subject: [PATCH] Updating documentation --- docs/source/api/aat_wrest/aat_wrest.rst | 8 + docs/source/api/carta_envoy/carta_envoy.rst | 53 +++++ docs/source/api/carta_envoy/modules.rst | 7 + docs/source/api/casa_envoy/casa_envoy.rst | 16 ++ docs/source/api/conveyor/conveyor.rst | 53 +++++ docs/source/api/conveyor/modules.rst | 7 + docs/source/api/core_sampler/core_sampler.rst | 45 ++++ docs/source/api/core_sampler/modules.rst | 7 + docs/source/api/index.rst | 6 + docs/source/api/ingest/ingest.files.rst | 29 +++ docs/source/api/ingest/ingest.metadata.rst | 21 ++ docs/source/api/ingest/ingest.pymygdala.rst | 29 +++ docs/source/api/ingest/ingest.rst | 217 ++++++++++++++++++ docs/source/api/ingest/ingest.schema.rst | 77 +++++++ .../api/ingest/ingest.weblog_thumbs.rst | 29 +++ docs/source/api/ingest/modules.rst | 8 + docs/source/api/ingest/pyat.events.rst | 21 ++ docs/source/api/ingest/pyat.mark4_import.rst | 29 +++ docs/source/api/ingest/pyat.qa_results.rst | 21 ++ docs/source/api/ingest/pyat.rst | 22 ++ docs/source/api/ingest/pyat.vlba_grabber.rst | 21 ++ docs/source/api/ingest/pyat.wf.rst | 45 ++++ docs/source/api/ingest_envoy/ingest_envoy.rst | 93 ++++++++ docs/source/api/ingest_envoy/modules.rst | 7 + docs/source/api/messaging/messaging.rst | 8 - docs/source/api/vela/vela.content.rst | 21 ++ docs/source/api/vela/vela.rst | 20 +- docs/source/api/wf_inspector/modules.rst | 7 + docs/source/api/wf_inspector/wf_inspector.rst | 21 ++ .../api/workspaces/workspaces.capability.rst | 16 ++ .../workspaces.capability.services.rst | 24 +- .../api/workspaces/workspaces.products.rst | 8 + .../workspaces.products.services.rst | 10 + docs/source/api/workspaces/workspaces.rst | 8 + .../api/workspaces/workspaces.system.rst | 26 ++- .../workspaces/workspaces.system.services.rst | 37 +++ .../api/workspaces/workspaces.workflow.rst | 8 + 37 files changed, 1046 insertions(+), 39 deletions(-) create mode 100644 docs/source/api/carta_envoy/carta_envoy.rst create mode 100644 docs/source/api/carta_envoy/modules.rst create mode 100644 docs/source/api/conveyor/conveyor.rst create mode 100644 docs/source/api/conveyor/modules.rst create mode 100644 docs/source/api/core_sampler/core_sampler.rst create mode 100644 docs/source/api/core_sampler/modules.rst create mode 100644 docs/source/api/ingest/ingest.files.rst create mode 100644 docs/source/api/ingest/ingest.metadata.rst create mode 100644 docs/source/api/ingest/ingest.pymygdala.rst create mode 100644 docs/source/api/ingest/ingest.rst create mode 100644 docs/source/api/ingest/ingest.schema.rst create mode 100644 docs/source/api/ingest/ingest.weblog_thumbs.rst create mode 100644 docs/source/api/ingest/modules.rst create mode 100644 docs/source/api/ingest/pyat.events.rst create mode 100644 docs/source/api/ingest/pyat.mark4_import.rst create mode 100644 docs/source/api/ingest/pyat.qa_results.rst create mode 100644 docs/source/api/ingest/pyat.rst create mode 100644 docs/source/api/ingest/pyat.vlba_grabber.rst create mode 100644 docs/source/api/ingest/pyat.wf.rst create mode 100644 docs/source/api/ingest_envoy/ingest_envoy.rst create mode 100644 docs/source/api/ingest_envoy/modules.rst create mode 100644 docs/source/api/vela/vela.content.rst create mode 100644 docs/source/api/wf_inspector/modules.rst create mode 100644 docs/source/api/wf_inspector/wf_inspector.rst create mode 100644 docs/source/api/workspaces/workspaces.products.services.rst create mode 100644 docs/source/api/workspaces/workspaces.system.services.rst diff --git a/docs/source/api/aat_wrest/aat_wrest.rst b/docs/source/api/aat_wrest/aat_wrest.rst index 808f6452a..dac6b8e41 100644 --- a/docs/source/api/aat_wrest/aat_wrest.rst +++ b/docs/source/api/aat_wrest/aat_wrest.rst @@ -28,6 +28,14 @@ aat\_wrest.utilities module :undoc-members: :show-inheritance: +aat\_wrest.wrest module +----------------------- + +.. automodule:: aat_wrest.wrest + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/api/carta_envoy/carta_envoy.rst b/docs/source/api/carta_envoy/carta_envoy.rst new file mode 100644 index 000000000..eb64bd3cb --- /dev/null +++ b/docs/source/api/carta_envoy/carta_envoy.rst @@ -0,0 +1,53 @@ +carta\_envoy package +==================== + +Submodules +---------- + +carta\_envoy.carta module +------------------------- + +.. automodule:: carta_envoy.carta + :members: + :undoc-members: + :show-inheritance: + +carta\_envoy.connect module +--------------------------- + +.. automodule:: carta_envoy.connect + :members: + :undoc-members: + :show-inheritance: + +carta\_envoy.launchers module +----------------------------- + +.. automodule:: carta_envoy.launchers + :members: + :undoc-members: + :show-inheritance: + +carta\_envoy.templates module +----------------------------- + +.. automodule:: carta_envoy.templates + :members: + :undoc-members: + :show-inheritance: + +carta\_envoy.utilities module +----------------------------- + +.. automodule:: carta_envoy.utilities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: carta_envoy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/carta_envoy/modules.rst b/docs/source/api/carta_envoy/modules.rst new file mode 100644 index 000000000..5180af922 --- /dev/null +++ b/docs/source/api/carta_envoy/modules.rst @@ -0,0 +1,7 @@ +carta_envoy +=========== + +.. toctree:: + :maxdepth: 4 + + carta_envoy diff --git a/docs/source/api/casa_envoy/casa_envoy.rst b/docs/source/api/casa_envoy/casa_envoy.rst index 4bc136f94..241c43cef 100644 --- a/docs/source/api/casa_envoy/casa_envoy.rst +++ b/docs/source/api/casa_envoy/casa_envoy.rst @@ -12,6 +12,14 @@ casa\_envoy.auditor module :undoc-members: :show-inheritance: +casa\_envoy.foundation module +----------------------------- + +.. automodule:: casa_envoy.foundation + :members: + :undoc-members: + :show-inheritance: + casa\_envoy.interfaces module ----------------------------- @@ -20,6 +28,14 @@ casa\_envoy.interfaces module :undoc-members: :show-inheritance: +casa\_envoy.launchers module +---------------------------- + +.. automodule:: casa_envoy.launchers + :members: + :undoc-members: + :show-inheritance: + casa\_envoy.palaver module -------------------------- diff --git a/docs/source/api/conveyor/conveyor.rst b/docs/source/api/conveyor/conveyor.rst new file mode 100644 index 000000000..7ccb2a1c5 --- /dev/null +++ b/docs/source/api/conveyor/conveyor.rst @@ -0,0 +1,53 @@ +conveyor package +================ + +Submodules +---------- + +conveyor.conveyor module +------------------------ + +.. automodule:: conveyor.conveyor + :members: + :undoc-members: + :show-inheritance: + +conveyor.deliver module +----------------------- + +.. automodule:: conveyor.deliver + :members: + :undoc-members: + :show-inheritance: + +conveyor.interfaces module +-------------------------- + +.. automodule:: conveyor.interfaces + :members: + :undoc-members: + :show-inheritance: + +conveyor.retrieve module +------------------------ + +.. automodule:: conveyor.retrieve + :members: + :undoc-members: + :show-inheritance: + +conveyor.solicitor module +------------------------- + +.. automodule:: conveyor.solicitor + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: conveyor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/conveyor/modules.rst b/docs/source/api/conveyor/modules.rst new file mode 100644 index 000000000..7f5a30b83 --- /dev/null +++ b/docs/source/api/conveyor/modules.rst @@ -0,0 +1,7 @@ +conveyor +======== + +.. toctree:: + :maxdepth: 4 + + conveyor diff --git a/docs/source/api/core_sampler/core_sampler.rst b/docs/source/api/core_sampler/core_sampler.rst new file mode 100644 index 000000000..0cd764d3f --- /dev/null +++ b/docs/source/api/core_sampler/core_sampler.rst @@ -0,0 +1,45 @@ +core\_sampler package +===================== + +Submodules +---------- + +core\_sampler.core\_sampler module +---------------------------------- + +.. automodule:: core_sampler.core_sampler + :members: + :undoc-members: + :show-inheritance: + +core\_sampler.database module +----------------------------- + +.. automodule:: core_sampler.database + :members: + :undoc-members: + :show-inheritance: + +core\_sampler.interfaces module +------------------------------- + +.. automodule:: core_sampler.interfaces + :members: + :undoc-members: + :show-inheritance: + +core\_sampler.row\_writer module +-------------------------------- + +.. automodule:: core_sampler.row_writer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: core_sampler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/core_sampler/modules.rst b/docs/source/api/core_sampler/modules.rst new file mode 100644 index 000000000..a12729113 --- /dev/null +++ b/docs/source/api/core_sampler/modules.rst @@ -0,0 +1,7 @@ +core_sampler +============ + +.. toctree:: + :maxdepth: 4 + + core_sampler diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index f20bf2595..4f8236624 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -9,12 +9,17 @@ API Documentation .. toctree:: :maxdepth: 1 + wf_inspector/modules + ingest_envoy/modules notification/modules + carta_envoy/modules + ingest/modules capability/modules aat_wrest/modules workspaces/modules ws_metrics/modules schema/modules + core_sampler/modules null/modules wf_monitor/modules workflow/modules @@ -22,6 +27,7 @@ API Documentation delivery/modules vela/modules tmpdir_eraser/modules + conveyor/modules casa_envoy/modules messaging/modules system_mediator/modules diff --git a/docs/source/api/ingest/ingest.files.rst b/docs/source/api/ingest/ingest.files.rst new file mode 100644 index 000000000..5cf09b224 --- /dev/null +++ b/docs/source/api/ingest/ingest.files.rst @@ -0,0 +1,29 @@ +ingest.files package +==================== + +Submodules +---------- + +ingest.files.ingestobs module +----------------------------- + +.. automodule:: ingest.files.ingestobs + :members: + :undoc-members: + :show-inheritance: + +ingest.files.ngasclient module +------------------------------ + +.. automodule:: ingest.files.ngasclient + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest.files + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/ingest.metadata.rst b/docs/source/api/ingest/ingest.metadata.rst new file mode 100644 index 000000000..3fc08320b --- /dev/null +++ b/docs/source/api/ingest/ingest.metadata.rst @@ -0,0 +1,21 @@ +ingest.metadata package +======================= + +Submodules +---------- + +ingest.metadata.sciencemodel module +----------------------------------- + +.. automodule:: ingest.metadata.sciencemodel + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest.metadata + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/ingest.pymygdala.rst b/docs/source/api/ingest/ingest.pymygdala.rst new file mode 100644 index 000000000..2b9bfe67b --- /dev/null +++ b/docs/source/api/ingest/ingest.pymygdala.rst @@ -0,0 +1,29 @@ +ingest.pymygdala package +======================== + +Submodules +---------- + +ingest.pymygdala.commands module +-------------------------------- + +.. automodule:: ingest.pymygdala.commands + :members: + :undoc-members: + :show-inheritance: + +ingest.pymygdala.models module +------------------------------ + +.. automodule:: ingest.pymygdala.models + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest.pymygdala + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/ingest.rst b/docs/source/api/ingest/ingest.rst new file mode 100644 index 000000000..25c554c8f --- /dev/null +++ b/docs/source/api/ingest/ingest.rst @@ -0,0 +1,217 @@ +ingest package +============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + ingest.files + ingest.metadata + ingest.pymygdala + ingest.schema + ingest.weblog_thumbs + +Submodules +---------- + +ingest.DBURLUtil module +----------------------- + +.. automodule:: ingest.DBURLUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.FITSUtil module +---------------------- + +.. automodule:: ingest.FITSUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.IDIFITSUtil module +------------------------- + +.. automodule:: ingest.IDIFITSUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.IngestionManifest module +------------------------------- + +.. automodule:: ingest.IngestionManifest + :members: + :undoc-members: + :show-inheritance: + +ingest.JSONMetadataUtil module +------------------------------ + +.. automodule:: ingest.JSONMetadataUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.NGASUtil module +---------------------- + +.. automodule:: ingest.NGASUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.RealFastMetadata module +------------------------------ + +.. automodule:: ingest.RealFastMetadata + :members: + :undoc-members: + :show-inheritance: + +ingest.UVFITSUtil module +------------------------ + +.. automodule:: ingest.UVFITSUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.VLBAFITSUtil module +-------------------------- + +.. automodule:: ingest.VLBAFITSUtil + :members: + :undoc-members: + :show-inheritance: + +ingest.almautils module +----------------------- + +.. automodule:: ingest.almautils + :members: + :undoc-members: + :show-inheritance: + +ingest.archive module +--------------------- + +.. automodule:: ingest.archive + :members: + :undoc-members: + :show-inheritance: + +ingest.archive\_caltables module +-------------------------------- + +.. automodule:: ingest.archive_caltables + :members: + :undoc-members: + :show-inheritance: + +ingest.archiveutils module +-------------------------- + +.. automodule:: ingest.archiveutils + :members: + :undoc-members: + :show-inheritance: + +ingest.commands module +---------------------- + +.. automodule:: ingest.commands + :members: + :undoc-members: + :show-inheritance: + +ingest.evlasciencedatamodel module +---------------------------------- + +.. automodule:: ingest.evlasciencedatamodel + :members: + :undoc-members: + :show-inheritance: + +ingest.manifestpersist module +----------------------------- + +.. automodule:: ingest.manifestpersist + :members: + :undoc-members: + :show-inheritance: + +ingest.persistVLBAmetadata module +--------------------------------- + +.. automodule:: ingest.persistVLBAmetadata + :members: + :undoc-members: + :show-inheritance: + +ingest.persistcaltables module +------------------------------ + +.. automodule:: ingest.persistcaltables + :members: + :undoc-members: + :show-inheritance: + +ingest.persistimages module +--------------------------- + +.. automodule:: ingest.persistimages + :members: + :undoc-members: + :show-inheritance: + +ingest.persistmetadata module +----------------------------- + +.. automodule:: ingest.persistmetadata + :members: + :undoc-members: + :show-inheritance: + +ingest.projectutils module +-------------------------- + +.. automodule:: ingest.projectutils + :members: + :undoc-members: + :show-inheritance: + +ingest.proposalqueries module +----------------------------- + +.. automodule:: ingest.proposalqueries + :members: + :undoc-members: + :show-inheritance: + +ingest.proposalutils module +--------------------------- + +.. automodule:: ingest.proposalutils + :members: + :undoc-members: + :show-inheritance: + +ingest.remotecopy module +------------------------ + +.. automodule:: ingest.remotecopy + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/ingest.schema.rst b/docs/source/api/ingest/ingest.schema.rst new file mode 100644 index 000000000..f6a60b836 --- /dev/null +++ b/docs/source/api/ingest/ingest.schema.rst @@ -0,0 +1,77 @@ +ingest.schema package +===================== + +Submodules +---------- + +ingest.schema.almamodel module +------------------------------ + +.. automodule:: ingest.schema.almamodel + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.legacy\_model module +---------------------------------- + +.. automodule:: ingest.schema.legacy_model + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.logs module +------------------------- + +.. automodule:: ingest.schema.logs + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.model module +-------------------------- + +.. automodule:: ingest.schema.model + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.ngasmodel module +------------------------------ + +.. automodule:: ingest.schema.ngasmodel + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.optmodel module +----------------------------- + +.. automodule:: ingest.schema.optmodel + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.pstmodel module +----------------------------- + +.. automodule:: ingest.schema.pstmodel + :members: + :undoc-members: + :show-inheritance: + +ingest.schema.vlassmodel module +------------------------------- + +.. automodule:: ingest.schema.vlassmodel + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest.schema + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/ingest.weblog_thumbs.rst b/docs/source/api/ingest/ingest.weblog_thumbs.rst new file mode 100644 index 000000000..2fb981377 --- /dev/null +++ b/docs/source/api/ingest/ingest.weblog_thumbs.rst @@ -0,0 +1,29 @@ +ingest.weblog\_thumbs package +============================= + +Submodules +---------- + +ingest.weblog\_thumbs.thumbnail\_finder module +---------------------------------------------- + +.. automodule:: ingest.weblog_thumbs.thumbnail_finder + :members: + :undoc-members: + :show-inheritance: + +ingest.weblog\_thumbs.weblogUtil module +--------------------------------------- + +.. automodule:: ingest.weblog_thumbs.weblogUtil + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest.weblog_thumbs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/modules.rst b/docs/source/api/ingest/modules.rst new file mode 100644 index 000000000..fdc4dad61 --- /dev/null +++ b/docs/source/api/ingest/modules.rst @@ -0,0 +1,8 @@ +ingest +====== + +.. toctree:: + :maxdepth: 4 + + ingest + pyat diff --git a/docs/source/api/ingest/pyat.events.rst b/docs/source/api/ingest/pyat.events.rst new file mode 100644 index 000000000..b6b47cff1 --- /dev/null +++ b/docs/source/api/ingest/pyat.events.rst @@ -0,0 +1,21 @@ +pyat.events package +=================== + +Submodules +---------- + +pyat.events.events module +------------------------- + +.. automodule:: pyat.events.events + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyat.events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/pyat.mark4_import.rst b/docs/source/api/ingest/pyat.mark4_import.rst new file mode 100644 index 000000000..47a4a78e7 --- /dev/null +++ b/docs/source/api/ingest/pyat.mark4_import.rst @@ -0,0 +1,29 @@ +pyat.mark4\_import package +========================== + +Submodules +---------- + +pyat.mark4\_import.audit module +------------------------------- + +.. automodule:: pyat.mark4_import.audit + :members: + :undoc-members: + :show-inheritance: + +pyat.mark4\_import.commands module +---------------------------------- + +.. automodule:: pyat.mark4_import.commands + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyat.mark4_import + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/pyat.qa_results.rst b/docs/source/api/ingest/pyat.qa_results.rst new file mode 100644 index 000000000..ab7d73b53 --- /dev/null +++ b/docs/source/api/ingest/pyat.qa_results.rst @@ -0,0 +1,21 @@ +pyat.qa\_results package +======================== + +Submodules +---------- + +pyat.qa\_results.commands module +-------------------------------- + +.. automodule:: pyat.qa_results.commands + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyat.qa_results + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/pyat.rst b/docs/source/api/ingest/pyat.rst new file mode 100644 index 000000000..906bb7d59 --- /dev/null +++ b/docs/source/api/ingest/pyat.rst @@ -0,0 +1,22 @@ +pyat package +============ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + pyat.events + pyat.mark4_import + pyat.qa_results + pyat.vlba_grabber + pyat.wf + +Module contents +--------------- + +.. automodule:: pyat + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/pyat.vlba_grabber.rst b/docs/source/api/ingest/pyat.vlba_grabber.rst new file mode 100644 index 000000000..6fa52a40c --- /dev/null +++ b/docs/source/api/ingest/pyat.vlba_grabber.rst @@ -0,0 +1,21 @@ +pyat.vlba\_grabber package +========================== + +Submodules +---------- + +pyat.vlba\_grabber.ngas\_retriever module +----------------------------------------- + +.. automodule:: pyat.vlba_grabber.ngas_retriever + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyat.vlba_grabber + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest/pyat.wf.rst b/docs/source/api/ingest/pyat.wf.rst new file mode 100644 index 000000000..cb36ad4dd --- /dev/null +++ b/docs/source/api/ingest/pyat.wf.rst @@ -0,0 +1,45 @@ +pyat.wf package +=============== + +Submodules +---------- + +pyat.wf.commands module +----------------------- + +.. automodule:: pyat.wf.commands + :members: + :undoc-members: + :show-inheritance: + +pyat.wf.ingest\_wf\_interfaces module +------------------------------------- + +.. automodule:: pyat.wf.ingest_wf_interfaces + :members: + :undoc-members: + :show-inheritance: + +pyat.wf.ous\_wf\_interfaces module +---------------------------------- + +.. automodule:: pyat.wf.ous_wf_interfaces + :members: + :undoc-members: + :show-inheritance: + +pyat.wf.utility\_wf\_interfaces module +-------------------------------------- + +.. automodule:: pyat.wf.utility_wf_interfaces + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyat.wf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest_envoy/ingest_envoy.rst b/docs/source/api/ingest_envoy/ingest_envoy.rst new file mode 100644 index 000000000..937b69909 --- /dev/null +++ b/docs/source/api/ingest_envoy/ingest_envoy.rst @@ -0,0 +1,93 @@ +ingest\_envoy package +===================== + +Submodules +---------- + +ingest\_envoy.collectors module +------------------------------- + +.. automodule:: ingest_envoy.collectors + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.ingest module +--------------------------- + +.. automodule:: ingest_envoy.ingest + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.ingestion\_manifest module +---------------------------------------- + +.. automodule:: ingest_envoy.ingestion_manifest + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.interfaces module +------------------------------- + +.. automodule:: ingest_envoy.interfaces + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.launchers module +------------------------------ + +.. automodule:: ingest_envoy.launchers + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.manifest\_components module +----------------------------------------- + +.. automodule:: ingest_envoy.manifest_components + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.schema module +--------------------------- + +.. automodule:: ingest_envoy.schema + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.solicitor module +------------------------------ + +.. automodule:: ingest_envoy.solicitor + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.std\_img\_manifest\_utils module +---------------------------------------------- + +.. automodule:: ingest_envoy.std_img_manifest_utils + :members: + :undoc-members: + :show-inheritance: + +ingest\_envoy.utilities module +------------------------------ + +.. automodule:: ingest_envoy.utilities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ingest_envoy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/ingest_envoy/modules.rst b/docs/source/api/ingest_envoy/modules.rst new file mode 100644 index 000000000..8d5b2a7ef --- /dev/null +++ b/docs/source/api/ingest_envoy/modules.rst @@ -0,0 +1,7 @@ +ingest_envoy +============ + +.. toctree:: + :maxdepth: 4 + + ingest_envoy diff --git a/docs/source/api/messaging/messaging.rst b/docs/source/api/messaging/messaging.rst index ee2e28967..9986ce28c 100644 --- a/docs/source/api/messaging/messaging.rst +++ b/docs/source/api/messaging/messaging.rst @@ -4,14 +4,6 @@ messaging package Submodules ---------- -messaging.event\_types module ------------------------------ - -.. automodule:: messaging.event_types - :members: - :undoc-members: - :show-inheritance: - messaging.messenger module -------------------------- diff --git a/docs/source/api/vela/vela.content.rst b/docs/source/api/vela/vela.content.rst new file mode 100644 index 000000000..02cebc523 --- /dev/null +++ b/docs/source/api/vela/vela.content.rst @@ -0,0 +1,21 @@ +vela.content package +==================== + +Submodules +---------- + +vela.content.forger\_content module +----------------------------------- + +.. automodule:: vela.content.forger_content + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: vela.content + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/vela/vela.rst b/docs/source/api/vela/vela.rst index fefdbbe53..589804b99 100644 --- a/docs/source/api/vela/vela.rst +++ b/docs/source/api/vela/vela.rst @@ -1,21 +1,29 @@ vela package ============ +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + vela.content + Submodules ---------- -vela.forger module ------------------- +vela.emulators module +--------------------- -.. automodule:: vela.forger +.. automodule:: vela.emulators :members: :undoc-members: :show-inheritance: -vela.interfaces module ----------------------- +vela.forger module +------------------ -.. automodule:: vela.interfaces +.. automodule:: vela.forger :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/wf_inspector/modules.rst b/docs/source/api/wf_inspector/modules.rst new file mode 100644 index 000000000..9c029b60e --- /dev/null +++ b/docs/source/api/wf_inspector/modules.rst @@ -0,0 +1,7 @@ +wf_inspector +============ + +.. toctree:: + :maxdepth: 4 + + wf_inspector diff --git a/docs/source/api/wf_inspector/wf_inspector.rst b/docs/source/api/wf_inspector/wf_inspector.rst new file mode 100644 index 000000000..c4e88ed14 --- /dev/null +++ b/docs/source/api/wf_inspector/wf_inspector.rst @@ -0,0 +1,21 @@ +wf\_inspector package +===================== + +Submodules +---------- + +wf\_inspector.inspector module +------------------------------ + +.. automodule:: wf_inspector.inspector + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: wf_inspector + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/workspaces/workspaces.capability.rst b/docs/source/api/workspaces/workspaces.capability.rst index 1f0c5d4f5..1a70956ac 100644 --- a/docs/source/api/workspaces/workspaces.capability.rst +++ b/docs/source/api/workspaces/workspaces.capability.rst @@ -36,6 +36,14 @@ workspaces.capability.helpers\_interfaces module :undoc-members: :show-inheritance: +workspaces.capability.message\_architect module +----------------------------------------------- + +.. automodule:: workspaces.capability.message_architect + :members: + :undoc-members: + :show-inheritance: + workspaces.capability.schema module ----------------------------------- @@ -52,6 +60,14 @@ workspaces.capability.schema\_interfaces module :undoc-members: :show-inheritance: +workspaces.capability.statemachine module +----------------------------------------- + +.. automodule:: workspaces.capability.statemachine + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/api/workspaces/workspaces.capability.services.rst b/docs/source/api/workspaces/workspaces.capability.services.rst index a6f2aafa9..742903fe3 100644 --- a/docs/source/api/workspaces/workspaces.capability.services.rst +++ b/docs/source/api/workspaces/workspaces.capability.services.rst @@ -4,14 +4,6 @@ workspaces.capability.services package Submodules ---------- -workspaces.capability.services.capability\_engine module --------------------------------------------------------- - -.. automodule:: workspaces.capability.services.capability_engine - :members: - :undoc-members: - :show-inheritance: - workspaces.capability.services.capability\_info module ------------------------------------------------------ @@ -20,14 +12,6 @@ workspaces.capability.services.capability\_info module :undoc-members: :show-inheritance: -workspaces.capability.services.capability\_queue module -------------------------------------------------------- - -.. automodule:: workspaces.capability.services.capability_queue - :members: - :undoc-members: - :show-inheritance: - workspaces.capability.services.capability\_service module --------------------------------------------------------- @@ -52,6 +36,14 @@ workspaces.capability.services.interfaces module :undoc-members: :show-inheritance: +workspaces.capability.services.queue\_manager module +---------------------------------------------------- + +.. automodule:: workspaces.capability.services.queue_manager + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/api/workspaces/workspaces.products.rst b/docs/source/api/workspaces/workspaces.products.rst index 0dafabbac..51dbb0aef 100644 --- a/docs/source/api/workspaces/workspaces.products.rst +++ b/docs/source/api/workspaces/workspaces.products.rst @@ -1,6 +1,14 @@ workspaces.products package =========================== +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + workspaces.products.services + Submodules ---------- diff --git a/docs/source/api/workspaces/workspaces.products.services.rst b/docs/source/api/workspaces/workspaces.products.services.rst new file mode 100644 index 000000000..13baa932f --- /dev/null +++ b/docs/source/api/workspaces/workspaces.products.services.rst @@ -0,0 +1,10 @@ +workspaces.products.services package +==================================== + +Module contents +--------------- + +.. automodule:: workspaces.products.services + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/workspaces/workspaces.rst b/docs/source/api/workspaces/workspaces.rst index 865527eb7..e3e158319 100644 --- a/docs/source/api/workspaces/workspaces.rst +++ b/docs/source/api/workspaces/workspaces.rst @@ -24,6 +24,14 @@ workspaces.cli module :undoc-members: :show-inheritance: +workspaces.shared\_interfaces module +------------------------------------ + +.. automodule:: workspaces.shared_interfaces + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/api/workspaces/workspaces.system.rst b/docs/source/api/workspaces/workspaces.system.rst index 92fa4fe22..08adce66d 100644 --- a/docs/source/api/workspaces/workspaces.system.rst +++ b/docs/source/api/workspaces/workspaces.system.rst @@ -1,29 +1,37 @@ workspaces.system package ========================= +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + workspaces.system.services + Submodules ---------- -workspaces.system.schema module -------------------------------- +workspaces.system.enums module +------------------------------ -.. automodule:: workspaces.system.schema +.. automodule:: workspaces.system.enums :members: :undoc-members: :show-inheritance: -workspaces.system.services module ---------------------------------- +workspaces.system.schema module +------------------------------- -.. automodule:: workspaces.system.services +.. automodule:: workspaces.system.schema :members: :undoc-members: :show-inheritance: -workspaces.system.services\_interfaces module ---------------------------------------------- +workspaces.system.views module +------------------------------ -.. automodule:: workspaces.system.services_interfaces +.. automodule:: workspaces.system.views :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/workspaces/workspaces.system.services.rst b/docs/source/api/workspaces/workspaces.system.services.rst new file mode 100644 index 000000000..536dc87cd --- /dev/null +++ b/docs/source/api/workspaces/workspaces.system.services.rst @@ -0,0 +1,37 @@ +workspaces.system.services package +================================== + +Submodules +---------- + +workspaces.system.services.archive\_service module +-------------------------------------------------- + +.. automodule:: workspaces.system.services.archive_service + :members: + :undoc-members: + :show-inheritance: + +workspaces.system.services.interfaces module +-------------------------------------------- + +.. automodule:: workspaces.system.services.interfaces + :members: + :undoc-members: + :show-inheritance: + +workspaces.system.services.remote\_processing\_service module +------------------------------------------------------------- + +.. automodule:: workspaces.system.services.remote_processing_service + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: workspaces.system.services + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/workspaces/workspaces.workflow.rst b/docs/source/api/workspaces/workspaces.workflow.rst index 191e25b89..12cf85695 100644 --- a/docs/source/api/workspaces/workspaces.workflow.rst +++ b/docs/source/api/workspaces/workspaces.workflow.rst @@ -20,6 +20,14 @@ workspaces.workflow.enum module :undoc-members: :show-inheritance: +workspaces.workflow.message\_architect module +--------------------------------------------- + +.. automodule:: workspaces.workflow.message_architect + :members: + :undoc-members: + :show-inheritance: + workspaces.workflow.schema module --------------------------------- -- GitLab