Post release doc updates - #266
Open
samaloney wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates end-user documentation to reflect post-release install guidance and refresh metadata/badges in the project README.
Changes:
- Updated the Zenodo badge/link in
README.rst. - Added brief
pip installinstructions (including the optionallegacyextra) to the README. - Added a new “Installing the release version” section to the installation tutorial.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.rst | Updates Zenodo DOI badge and adds quick pip install instructions. |
| docs/tutorials/installation.rst | Adds release-install instructions and adjusts surrounding installation narrative. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+28
to
+29
| .. |Zenodo - Latest DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.11526911.svg | ||
| :target: https://doi.org/10.5281/zenodo.11526911 |
Comment on lines
+10
to
+13
| To install the current release version of ``sunkit-spex`` use pip | ||
|
|
||
| .. code-block:: | ||
|
|
Comment on lines
+16
to
+19
| or with the legacy optional dependency which are needed to use the legacy fitting code and examples | ||
|
|
||
| .. code-block:: | ||
|
|
| Installing the development version | ||
| ---------------------------------- | ||
| Sunkit-spex is still under development, and no stable version has been released. However, users can install the the development version. | ||
| ``sunkit-spex`` is still under development, and no stable version has been released. However, users can install the the development version. |
This file contains hidden or 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
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
Update readme
Update install guide
AI Assistance Disclosure
AI tools were used for: