Move Documentation to readthedocs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 95
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 1
Description
Right now all the documentation for this library is in README.md. It's getting pretty unwieldy at this point, and should really probably be moved into a hosted page somewhere.
I've used readthedocs.org before, and it works pretty well. We'll have to refactor the README documentation into sphinx documentation first, but that shouldn't be too tricky.
Tasks:
- refactor documentation into a
docs/folder, usingsphinx - enable/connect readthedocs
- update
README.md- to point to the hosted documentation
- to only have a feature overview and basic quickstart
- (maybe) update repo description with the docs link
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.md and review the existing documentation structure before creating the planned docs/ folder with Sphinx. Configure the project for Read the Docs, then keep README.md limited to a feature overview and basic quickstart with a link to the hosted documentation. Done means the documentation is hosted and the README points readers to it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100