search

CCSDSPy / ccsdspy

I/O interface and utilities for CCSDS binary spacecraft data in Python. Library used in flight missions at NASA, NOAA, and SWRI
https://ccsdspy.org
BSD 3-Clause "New" or "Revised" License
75 stars 18 forks source link

Add documentation for variable length packets #39

Closed ehsteve closed 1 year ago

ehsteve commented 1 year ago

Looks like there isn't an example provided for variable length packets besides the API reference.

ddasilva commented 1 year ago

Agreed, this is a good idea. Do you think the front page is too long? We could add this as another section under the FixedLength example, or we could add a variable length page on the sidebar and add text "For variable length packets, see the Variable Length page."

ehsteve commented 1 year ago

I started writing up a description of what I thought should be done but then decided it would be easier to just show you! see #41!

I tried to make the docs a bit more standardized. Sorry, I removed your custom navigation which I found confusing.

I also fixed the sphinx documentation links so you can now link to the code as well as link out to the dependencies like numpy.

ddasilva commented 1 year ago

The associated PR was merged and the site has been rebuild. closing