mcdc-project / mcdc-project/mcdc
Test for warnings in documentation builds
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 61
- Forks
- 38
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 10
Description
When I was building the sphinx documentation locally with make html I noticed quite a few warnings were being issued, which usually means the documentation will be there, but the formatting will be wrong. You can make these fatal errors for Sphinx if you want to set the standard that formatting errors aren't allowed with:
sphinx-build <source> <output> -W --keep-going -E
This is what we do in MontePy's CI.
Contributor guide
No contributing guide indexed for this repository
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 running the documentation build with make html and review the warnings it emits. Compare the suggested sphinx-build flags with the documentation workflow configuration; done means the documentation build treats warnings as fatal and the relevant check passes without warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100