Modify documentation for use with readthedocs.org
Open
Nobody has claimed this yet.
documentation
high priority
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 763
- PR merge metrics
- No merged PRs in 30d
Description
Our RST doc format is fine for use with GitHub but other tools need the format to be tweaked. In particular, we want to support a copy of these docs on readthedocs.org
Contributor guide
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 by locating the repository's RST documentation and reviewing how it is currently rendered on GitHub. Compare that format with readthedocs.org requirements, then update the documentation so a copy can be built there and verify that both documentation targets remain usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100