Add spice module to documentation #1010
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lots of changes to get the spinx documentaton right
subagonsouth
added
the
Repo: Documentation
subagonsouth
requested review from
a team,
vmartinez-cu,
laspsandoval and
maxinelasp
and removed request for
a team
subagonsouth
commented
Oct 11, 2024
| @@ -117,6 +117,9 @@ | |||
| (r"py:.*", r".*np.ndarray.*"), | |||
| (r"py:.*", r".*numpy._typing._array_like._ScalarType_co.*"), | |||
| (r"py:.*", r".*idex.l1a.TRIGGER_DESCRIPTION.*"), | |||
| (r"py:.*", r".*.spice.geometry.SpiceBody.*"), | |||
There was a problem hiding this comment.
More nitpick ignores for IntEnums and some numpy_typing. What confuses me is that theses sphinx warnings would go away if I built the documentation a second time without cleaning. I simply couldn't figure out how to fix these issues without just adding the ignore regex here.
subagonsouth
commented
Oct 11, 2024
| @@ -96,10 +97,11 @@ def imap_state( | |||
| ---------- | |||
| et : np.ndarray or float | |||
| Epoch time(s) [J2000 seconds] to get the IMAP state for. | |||
| ref_frame : SpiceFrame, optional | |||
There was a problem hiding this comment.
I have no clue why sphinx was having problems with this optional here, which adheres to numpydoc syntax. I spent way too long trying to fix it but ended up just having to remove it.
maxinelasp
approved these changes
Oct 11, 2024
subagonsouth
merged commit f6204d2
into
IMAP-Science-Operations-Center:dev
17 checks passed
subagonsouth
deleted the
996-add-spice-directory-to-the-documentation-build
branch
20 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Overview
These are all changes that were needed to add the spice directory to the documentation build and fix some formatting issues.