Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs improvements #96

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
9 changes: 0 additions & 9 deletions docs/api/ccsds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,3 @@ CCSDS Package
:members:
:undoc-members:
:show-inheritance:
:no-index:

Spacepacket Module
-------------------------------------

.. automodule:: spacepackets.ccsds.spacepacket
:members:
:undoc-members:
:show-inheritance:
14 changes: 0 additions & 14 deletions docs/api/cfdp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------

Expand All @@ -36,11 +30,3 @@ Length-Value (LV) Submodule
:members:
:undoc-members:
:show-inheritance:

Common Definitions
-------------------------------------

.. automodule:: spacepackets.cfdp.defs
:members:
:undoc-members:
:show-inheritance:
48 changes: 0 additions & 48 deletions docs/api/cfdp_tlv.rst

This file was deleted.

28 changes: 5 additions & 23 deletions docs/api/ecss.rst
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
7 changes: 0 additions & 7 deletions docs/api/ecss_tc.rst

This file was deleted.

15 changes: 0 additions & 15 deletions docs/api/ecss_tm.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -----------------------------------------------------

Expand All @@ -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 ---------------------------------------------------
Expand Down
3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading