Add documentation link and badge to README - #962
Closed
SergioCc13 wants to merge 1 commit into
Closed
Conversation
The README (and therefore the PyPI long description) had no pointer to https://pynacl.readthedocs.io/. Add a Latest Documentation badge next to the PyPI badge and a short Documentation section. Closes pyca#877
Author
|
On reflection this is too minor to justify the review burden — closing. Happy to revisit #877 if a maintainer would find it useful. |
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
1 participant
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.
Fixes #877.
The
README.rst(which is also rendered as the long description onhttps://pypi.org/project/PyNaCl/) had no pointer to the hosted docs at
https://pynacl.readthedocs.io/. The only mention of Read the Docs was the
Changeloglink further down.This adds:
Verified
README.rststill parses cleanly withdocutils(only thepre-existing INFO about the
changelogtarget name). Badge and doc URLsboth return 200.