Merge pull request #96 from us-irs/docs-improvements

doc improvements

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

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:

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:

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:

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 ---------------------------------------------------

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 <api/ccsds_time:CDS Time Submodule>`.
 - PUS Telecommand and PUS Telemetry implementation according to the
-  `ECSS-E-ST-70-41C standard`_: :ref:`TC API <api/ecss_tc:ECSS Telecommand Module>` and
-  :ref:`TM API <api/ecss_tm:ECSS Telemetry Module>`.
+  `ECSS-E-ST-70-41C standard`_: :ref:`API <api/ecss:ECSS Package>`
 - CCSDS File Delivery Protcol (CFDP) packet implementations according to
   `CCSDS Blue Book 727.0-B-5`_: :ref:`API <api/cfdp:CFDP Package>`
 - Unified Space Data Link Protocol (USLP) frame implementations according to