openedx / openedx/openedx-platform
Fix AutoAPI issues for edx-platform readthedocs Builds
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
AutoAPI caused performance issues when building the edx-platform docs on ReadTheDocs, so we had to temporarily disable it.
We need to dig into what’s causing the problem and figure out how we can optimize or adjust the setup to bring AutoAPI back without hitting RTD’s resource limits. This might include reviewing directory structures, excluding unnecessary files, or tweaking the configuration.
References:
https://github.com/openedx/edx-platform/issues/35807
https://github.com/openedx/edx-platform/pull/35846
https://github.com/openedx/edx-platform/pull/35939
https://readthedocs.org/projects/edx-platform-docs/builds/
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 linked issue and pull requests, then inspect the referenced ReadTheDocs build history to identify where AutoAPI exceeds resource limits. Done means AutoAPI is enabled for edx-platform documentation builds without reproducing the reported performance or resource problems.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100