Documentation for bindings does not appear in documentation in readthedocs.io
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.2k
- Forks
- 267
- Avg merge
- 42m
- Merged PRs (30d)
- 2
Description
The documentation for crypto_sign_ed25519_pk_to_curve25519 and crypto_sign_ed25519_sk_to_curve25519 does not appear in the documentation on https://pynacl.readthedocs.io . I would therefore expect that the whole document of nacl.bindings are missing from the documentation.
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
Compare the published PyNaCl documentation at pynacl.readthedocs.io with the documentation for nacl.bindings, focusing first on crypto_sign_ed25519_pk_to_curve25519 and crypto_sign_ed25519_sk_to_curve25519. Trace how the nacl.bindings documentation is configured and rendered; done means the bindings documentation, including these functions, appears on Read the Docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100