start of NASA PDART funded work to add select required reading docume…

…nts to spiceypy docs. Copied all 10 and mostly worked out decisions with abcorr doc, will propogate to others once sidebar toc fixed
AndrewAnnex · Jan 8, 2025 · fc77896 · fc77896
1 parent 3c6b466
commit fc77896
Show file tree

Hide file tree

Showing 12 changed files with 26,312 additions and 1 deletion.
diff --git a/docs/abcorr.rst b/docs/abcorr.rst
diff --git a/docs/ck.rst b/docs/ck.rst
diff --git a/docs/ellipses.rst b/docs/ellipses.rst
diff --git a/docs/frames.rst b/docs/frames.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -46,7 +46,7 @@ function, more detailed explanations are deferred to the NAIF via those links.
 Contents:
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    citation
    installation
@@ -55,6 +55,7 @@ Contents:
    cells
    exceptions
    contextmanager
+   requiredindex
    lessonindex
    documentation
 

diff --git a/docs/kernel.rst b/docs/kernel.rst
diff --git a/docs/naif_ids.rst b/docs/naif_ids.rst
diff --git a/docs/pck.rst b/docs/pck.rst
diff --git a/docs/planes.rst b/docs/planes.rst
diff --git a/docs/requiredindex.rst b/docs/requiredindex.rst
@@ -0,0 +1,26 @@
+Required Reading
+================
+
+Here listed are a selection of required reading documents provided by the NAIF translated to
+use Python code examples where applicable. Please refer to the NAIF's full required reading files 
+for additional material naifrequired_.
+
+.. _naifrequired: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   abcorr 
+   ck 
+   ellipses 
+   frames 
+   kernel 
+   naif_ids 
+   pck 
+   planes 
+   sclk 
+   spk 
+
+
diff --git a/docs/sclk.rst b/docs/sclk.rst
diff --git a/docs/spk.rst b/docs/spk.rst