Add pfsspy heritage docs page #38
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
nabobalis
reviewed
May 2, 2024
docs/heritage.rst
Outdated
| ``pfsspy`` | ||
| ========== | ||
|
|
||
| As of initial release, the main component of ``sunkit-magex`` (`sunkit_magex.pfss`) is |
There was a problem hiding this comment.
I am going to be annoying, but we can we get one sentence per line?
nabobalis
reviewed
May 2, 2024
docs/index.rst
Outdated
| generated/gallery/index | ||
| reference/index | ||
| reference/index |
There was a problem hiding this comment.
These whitespace issues, can be fixed by either running pre-commit, using the pre-commit bot or tox -e codestyle.
nabobalis
reviewed
May 2, 2024
nabobalis
approved these changes
May 2, 2024
Format for single use URLs Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
|
@dstansby - if you have a chance to look over the content here, I'd be glad to include any details you want to add. |
Cadair
approved these changes
May 2, 2024
dstansby
approved these changes
May 2, 2024
|
thanks everyone! |
Closed
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.
PR Description
Add a new docs page which describes the heritage of
sunkit-magex.pfssfrompfsspy. Addresses action listed in #36Changes:
pfsspylink in sphinx config to allow linking to its readthedocsCurrent issue with PR - new entry appears in landing page table of contents when tested with tox locally but not in html sidebar