From 1d298ebed7123fb9d865dbcc07a55a8f3f57f1bf Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 11 Dec 2024 16:44:49 +0100 Subject: [PATCH] doc improvements --- docs/api.rst | 8 ++------ docs/api/ccsds.rst | 9 -------- docs/api/cfdp.rst | 14 ------------- docs/api/cfdp_tlv.rst | 48 ------------------------------------------- docs/api/ecss.rst | 28 +++++-------------------- docs/api/ecss_tc.rst | 7 ------- docs/api/ecss_tm.rst | 15 -------------- docs/conf.py | 4 ++-- docs/index.rst | 3 +-- 9 files changed, 10 insertions(+), 126 deletions(-) delete mode 100644 docs/api/cfdp_tlv.rst delete mode 100644 docs/api/ecss_tc.rst delete mode 100644 docs/api/ecss_tm.rst diff --git a/docs/api.rst b/docs/api.rst index 833e2de..31212ed 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -3,9 +3,8 @@ API Documentation This package is split into multiple submodules: -- :py:mod:`spacepackets.ccsds`: Contains CCSDS specific code. This includes the space packet - implementation inside the :py:mod:`spacepackets.ccsds.spacepacket` module and time related - implementations in the :py:mod:`spacepackets.ccsds.time` module +- :py:mod:`spacepackets.ccsds`: Contains CCSDS specific code. This includes the CCSDS space packet + helpers and the CCSDS time implementations in the :py:mod:`spacepackets.ccsds.time` module. - :py:mod:`spacepackets.cfdp`: Contains packet implementations related to the CCSDS File Delivery Protocol - :py:mod:`spacepackets.ecss`: Contains packet implementations related to the ECSS PUS standard. - :py:mod:`spacepackets.uslp`: Contains packet implementations related to the USLP standard. @@ -22,11 +21,8 @@ This package also uses the :py:mod:`logging` package to emit warnings. api/ccsds api/ccsds_time api/ecss - api/ecss_tc - api/ecss_tm api/cfdp api/cfdp_pdu - api/cfdp_tlv api/uslp api/countdown api/seqcount diff --git a/docs/api/ccsds.rst b/docs/api/ccsds.rst index 1e51034..ba05210 100644 --- a/docs/api/ccsds.rst +++ b/docs/api/ccsds.rst @@ -5,12 +5,3 @@ CCSDS Package :members: :undoc-members: :show-inheritance: - :no-index: - -Spacepacket Module -------------------------------------- - -.. automodule:: spacepackets.ccsds.spacepacket - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/cfdp.rst b/docs/api/cfdp.rst index 9569c1f..62a1016 100644 --- a/docs/api/cfdp.rst +++ b/docs/api/cfdp.rst @@ -8,18 +8,12 @@ Package Contents :members: :undoc-members: :show-inheritance: - :no-index: PDU Submodule ---------------- :ref:`api/cfdp_pdu:CFDP PDU Subpackage` -Type-Length-Value (TLV) Submodule -------------------------------------- - -:ref:`api/cfdp_tlv:CFDP Type-Length-Value (TLV) Subpackage` - Configuration Submodule ------------------------------------- @@ -36,11 +30,3 @@ Length-Value (LV) Submodule :members: :undoc-members: :show-inheritance: - -Common Definitions -------------------------------------- - -.. automodule:: spacepackets.cfdp.defs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/cfdp_tlv.rst b/docs/api/cfdp_tlv.rst deleted file mode 100644 index d4e4bd2..0000000 --- a/docs/api/cfdp_tlv.rst +++ /dev/null @@ -1,48 +0,0 @@ -CFDP Type-Length-Value (TLV) Subpackage -======================================== - -.. automodule:: spacepackets.cfdp.tlv - :members: - :undoc-members: - :show-inheritance: - :no-index: - -Definitions Module --------------------- - -.. automodule:: spacepackets.cfdp.tlv.defs - :members: - :undoc-members: - :show-inheritance: - -TLV Module -------------- - -.. automodule:: spacepackets.cfdp.tlv.tlv - :members: - :undoc-members: - :show-inheritance: - -TLV Holder Module ------------------- - -.. automodule:: spacepackets.cfdp.tlv.holder - :members: - :undoc-members: - :show-inheritance: - -Message To User TLV Module ----------------------------- - -.. automodule:: spacepackets.cfdp.tlv.msg_to_user - :members: - :undoc-members: - :show-inheritance: - -Base Module ----------------------------- - -.. automodule:: spacepackets.cfdp.tlv.base - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/ecss.rst b/docs/api/ecss.rst index 8021372..5c56fa7 100644 --- a/docs/api/ecss.rst +++ b/docs/api/ecss.rst @@ -1,31 +1,13 @@ ECSS Package ======================= -.. automodule:: spacepackets.ecss - :members: - :undoc-members: - :show-inheritance: - :no-index: - -.. automodule:: spacepackets.ecss.defs - :members: - :undoc-members: - :show-inheritance: - -ECSS PUS Telecommand Module ----------------------------- - -:ref:`api/ecss_tc:ECSS Telecommand Module` - -ECSS PUS Telemetry Module ----------------------------- +The following classes can be used to create and read +ECSS PUS-C packets: -:ref:`api/ecss_tm:ECSS Telemetry Module` +- :py:class:`spacepackets.ecss.PusTc` +- :py:class:`spacepackets.ecss.PusTm` -ECSS Fields Submodule ----------------------------------- - -.. automodule:: spacepackets.ecss.fields +.. automodule:: spacepackets.ecss :members: :undoc-members: :show-inheritance: diff --git a/docs/api/ecss_tc.rst b/docs/api/ecss_tc.rst deleted file mode 100644 index 0c132fd..0000000 --- a/docs/api/ecss_tc.rst +++ /dev/null @@ -1,7 +0,0 @@ -ECSS Telecommand Module -=============================== - -.. automodule:: spacepackets.ecss.tc - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/ecss_tm.rst b/docs/api/ecss_tm.rst deleted file mode 100644 index 3fb005e..0000000 --- a/docs/api/ecss_tm.rst +++ /dev/null @@ -1,15 +0,0 @@ -ECSS Telemetry Module -======================== - -.. automodule:: spacepackets.ecss.tm - :members: - :undoc-members: - :show-inheritance: - -PUS Verificator Module -------------------------------------- - -.. automodule:: spacepackets.ecss.pus_verificator - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 9d068fc..69ae0c5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -from spacepackets.version import get_version +from importlib.metadata import version # -- Project information ----------------------------------------------------- @@ -19,7 +19,7 @@ author = "Robin Mueller" # The full version, including alpha/beta/rc tags -version = release = get_version() +release = version = version("spacepackets") # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 267bd3b..f9d8fe1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,8 +17,7 @@ Currently, this includes the following components: - CCSDS CDS short timestamp implementation according to `CCSDS 301.0-B-4 3.3`_: :ref:`API `. - PUS Telecommand and PUS Telemetry implementation according to the - `ECSS-E-ST-70-41C standard`_: :ref:`TC API ` and - :ref:`TM API `. + `ECSS-E-ST-70-41C standard`_: :ref:`API ` - CCSDS File Delivery Protcol (CFDP) packet implementations according to `CCSDS Blue Book 727.0-B-5`_: :ref:`API ` - Unified Space Data Link Protocol (USLP) frame implementations according to