Documentation: Point to documentation in README and in PyPI listing
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.2k
- Forks
- 267
- Avg merge
- 42m
- Merged PRs (30d)
- 2
Description
Neither the README.rst file for this repository nor the project information, as presented on https://pypi.org/project/PyNaCl/ (v1.5.0) give any indication that https://pynacl.readthedocs.io/en/latest/ exists.
I now see that that a Documentation URL is now in pyproject.toml for version 1.6.0.dev1, so I am hoping that that will be released soon, so I am just recommending that the README be updated.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.rst and compare its project information with the Documentation URL already present in pyproject.toml for version 1.6.0.dev1. Confirm how PyPI derives its project links, then update the README so it points to the existing Read the Docs site and verify the rendered project information includes the documentation link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100