openedx / openedx/api-doc-tools
Build generated API docs for ReadTheDocs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
I believe this is implemented in edx-platform, but it needs to be pulled into this library.
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 comparing the API documentation tooling in this repository with the existing implementation in edx-platform, then trace how generated documentation is built for ReadTheDocs. Done means the relevant generated API documentation from edx-platform is pulled into this library and builds successfully for ReadTheDocs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100