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

Add (some) Required Reading to Docs #489

Merged
merged 19 commits into from
Mar 10, 2025
Merged
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
fc77896
start of NASA PDART funded work to add select required reading docume…
AndrewAnnex Jan 8, 2025
52c76f0
many formatting improvements made across req docs
AndrewAnnex Jan 8, 2025
11cdcdc
fix a lot of warnings and critical errors
AndrewAnnex Jan 8, 2025
e911a90
adjust yaml
AndrewAnnex Jan 9, 2025
31593e1
added req reading urls to top of all new docs, lots of formatting pro…
AndrewAnnex Jan 21, 2025
19e07fb
reformatted and mostly completed abcorr, ellipses, planes
AndrewAnnex Jan 22, 2025
5d37aec
figured out a regex to quickly convert over most cross references to …
AndrewAnnex Jan 22, 2025
c215164
some additional reformatting, trimming of whitespace
AndrewAnnex Jan 22, 2025
ca88665
seemingly finished first pass at sclk and naif_ids
AndrewAnnex Feb 5, 2025
859f9db
first pass through frames done
AndrewAnnex Feb 5, 2025
834ed15
first pass at pck
AndrewAnnex Feb 5, 2025
c5634f5
[no ci] trim whitespace from pck
AndrewAnnex Feb 5, 2025
3852d32
Merge remote-tracking branch 'origin/main' into add_req_reading
AndrewAnnex Feb 5, 2025
3904d55
first pass at kernels done, may have some go backs on white spaces an…
AndrewAnnex Feb 5, 2025
9244582
fix issue in pck
AndrewAnnex Feb 5, 2025
c3cc00f
[no ci] fix missed ref
AndrewAnnex Feb 5, 2025
792fafa
progress on spk and ck, additional changes elsewhere
AndrewAnnex Feb 21, 2025
4b88250
adjustments to window.req links to also mention the other stuff tutorial
AndrewAnnex Feb 27, 2025
6cb08d6
fixes for spk req reading
AndrewAnnex Mar 10, 2025
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
Prev Previous commit
Next Next commit
added req reading urls to top of all new docs, lots of formatting pro…
…gress on abcorr, so nearing completion there
AndrewAnnex committed Jan 21, 2025
commit 31593e1e4fa7bc73f7cd02c5cdb9dce3f44fc66a
495 changes: 207 additions & 288 deletions docs/abcorr.rst

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/binary_pck.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Binary PCK Hands-On Lesson
===========================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/binary_pck.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/binary_pck.html>`_

November 20, 2017

Overview
3 changes: 3 additions & 0 deletions docs/ck.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
=========================
C-Kernel Required Reading
=========================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/ck.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/ck.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4 changes: 3 additions & 1 deletion docs/ellipses.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
========================================
Ellipses and Ellipsoids Required Reading
========================================


This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/ellipses.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/ellipses.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2 changes: 2 additions & 0 deletions docs/frames.rst
Original file line number Diff line number Diff line change
@@ -2,6 +2,8 @@
Reference Frames
================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/frames.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/frames.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
@@ -49,7 +49,7 @@ Offline installation
--------------------

If you need to install SpiceyPy without a network or if you have a prebuilt shared library at hand,
you can override the default behaviour of SpiceyPy by using the CSPICE_SRC_DIR and CSPICE_SHARED_LIB environment variables respectively.
you can override the default behavior of SpiceyPy by using the CSPICE_SRC_DIR and CSPICE_SHARED_LIB environment variables respectively.

For example, if you have downloaded SpiceyPy and the CSPICE toolkit, and extracted CSPICE to /tmp/cspice you can run:

3 changes: 2 additions & 1 deletion docs/kernel.rst
Original file line number Diff line number Diff line change
@@ -2,7 +2,8 @@
SPICE Kernel Required Reading
=============================


This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/kernel.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/kernel.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3 changes: 3 additions & 0 deletions docs/naif_ids.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
=====================
NAIF Integer ID codes
=====================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/naif_ids.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/naif_ids.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4 changes: 3 additions & 1 deletion docs/pck.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
====================
PCK Required Reading
====================


This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/pck.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/pck.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2 changes: 2 additions & 0 deletions docs/planes.rst
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@
Planes Required Reading
=======================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/planes.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/planes.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2 changes: 2 additions & 0 deletions docs/sclk.rst
Original file line number Diff line number Diff line change
@@ -2,6 +2,8 @@
SCLK Required Reading
=====================

This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/sclk.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/sclk.html>`_

Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4 changes: 3 additions & 1 deletion docs/spk.rst
Original file line number Diff line number Diff line change
@@ -2,7 +2,9 @@
SPK Required Reading
====================


This required reading document is reproduced from the original NAIF
document available at `https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/spk.html <https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/spk.html>`_


Abstract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^