Include README in readthedocs front page (#44)

Add Libera, MMS, and CTIM logos to missions list
Add DOI badge to README

README.md

@@ -1,10 +1,11 @@
 # Space Packet Parser
 
 ----------
-![Test Status](https://github.com/medley56/space_packet_parser/actions/workflows/tests.yml/badge.svg)
-![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)
+[![Test Status](https://github.com/medley56/space_packet_parser/actions/workflows/tests.yml/badge.svg)](https://github.com/medley56/space_packet_parser/actions/workflows/tests.yml)
+[![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)](https://readthedocs.org/projects/space-packet-parser/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7735001.svg)](https://doi.org/10.5281/zenodo.7735001)
 
-Documentation: https://space-packet-parser.readthedocs.io/en/latest/
+Documentation: [https://space-packet-parser.readthedocs.io/en/latest/](https://space-packet-parser.readthedocs.io/en/latest/)
 
 Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. 
 It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the 
@@ -23,4 +24,7 @@ pip install space_packet_parser
 ## Missions using Space Packet Parser
 
 [<img src="https://imap.princeton.edu/sites/g/files/toruqf1601/files/imap-mark-hor-multicolor-dark.png" alt="IMAP" height="70"/>](https://imap.princeton.edu/)
-[<img src="https://clarreo-pathfinder.larc.nasa.gov/wp-content/uploads/sites/133/2019/08/clarreo_pathfinder_mission_patch_design_v4_decal_1_24_17.png" alt="IMAP" height="70"/>](https://clarreo-pathfinder.larc.nasa.gov/)
+[<img src="https://clarreo-pathfinder.larc.nasa.gov/wp-content/uploads/sites/133/2019/08/clarreo_pathfinder_mission_patch_design_v4_decal_1_24_17.png" alt="CLARREO" height="140"/>](https://clarreo-pathfinder.larc.nasa.gov/)
+[<img src="https://lasp.colorado.edu/libera/files/2021/02/Libera-Logo-HiRes.png" alt="Libera" height="70"/>](https://lasp.colorado.edu/libera/)
+[<img src="https://lasp.colorado.edu/ctim/files/2023/01/CTIM_LOGO_350x100_centered_transparent.png" alt="CTIM-FD" height="70"/>](https://lasp.colorado.edu/ctim/)
+[<img src="https://mms.gsfc.nasa.gov/images/promotional_materials/mms_decal_rgb_4in_trabk_72dpi.png" alt="MMS-FEEPS" height="140"/>](https://lasp.colorado.edu/mms/sdc/public/)

docs/source/conf.py

@@ -19,6 +19,10 @@
     "autoapi.extension"
 ]
 
+myst_enable_extensions = [
+    "html_image"
+]
+
 autoapi_type = 'python'
 autoapi_dirs = ['../../space_packet_parser']
 

docs/source/contents.rst

@@ -0,0 +1,8 @@
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   users.md
+   developers.md
+   changelog.md
+   autoapi/index.rst

docs/source/index.rst

@@ -1,32 +1,7 @@
 Space Packet Parser Documentation
 =================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+.. include:: contents.rst
 
-   users.md
-   developers.md
-   changelog.md
-   autoapi/index.rst
-
-
-Indices and Tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-
-Instruments and Missions
-========================
-
-The following programs are using space packet parser in some capacity (most for decoding science data packets).
-
-* `CLARREO Pathfinder <https://clarreo-pathfinder.larc.nasa.gov/>`_
-* `CTIM-FD <https://esto.nasa.gov/invest/ctim/>`_
-* FEEPS
-* `IDEX <https://imap.princeton.edu/instruments/idex>`_
-* `IMAP <https://imap.princeton.edu/>`_
-* `Libera <https://lasp.colorado.edu/home/libera/>`_
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_

docs/source/users.md

@@ -1,4 +1,4 @@
-# User Documentation
+# User Documentation (Getting Started)
 ## Installation
 This package is distributed via PyPI. To install it with pip, run: