Investigate using Sphinx to generate documentation
Open
@Devaraj-G is already working on this.
Since Aug 4, 2022.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Apparently Sphinx can automatically generate documentation. Let's have a go and see what it tells us about the code.
Expected outputs:
- Some documentation generated by sphinx
- New issues to improve documentation based on what we've learned
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.
Assessment
This issue has not been assessed yet.