openedx / openedx/api-doc-tools
Get readthedocs auto-published
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
- Auto-build docs on PRs.
- Eventually, fail PRs if docs don't build
- In IDAs, push docs on releases (which should be tagged!)
- In edx-platform, on master merges or weekly or release, push docs to RTFD
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 reviewing the repository's documentation-generation tooling and its existing release or CI entry points. Map the requested workflows for PRs, releases, master merges, weekly runs, and tagged releases across IDAs and edx-platform. Done means the agreed ReadTheDocs publishing and build-failure behavior is implemented and verified for each selected trigger.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100