openedx / openedx/edx-django-utils
Readthedocs build should fail on warnings
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 31
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 1
Description
In order to do this, we should set fail_on_warning: true in .readthedocs.yaml.
Before doing so, however, we need to investigate and resolve the numerous autodoc warnings from the build.
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 with the Read the Docs build configuration in .readthedocs.yaml and inspect the build output for the reported autodoc warnings. Resolve the warnings first, then set fail_on_warning: true and verify that the documentation build fails when warnings remain.
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
- Mostly clear
- Newbie friendliness
- 35/100