ReadTheDocs build is broken
pllim opened this issue · comments
At the time of opening this issue, the last successful build was over 3 weeks ago (July 24, 2022): https://readthedocs.org/projects/pyautogalaxy/builds/
Also see #50
This build is now successful: https://readthedocs.org/projects/pyautogalaxy/builds/
We intend to prevent releases via our biuld server if readthedocs does not build successfully - if you have a suggestion on how to do this it'd be much appreciated!
If you want to prevent release with failed RTD, you could run the same sphinx command that RTD runs as one of your release steps. It is in the logs:
.../bin/python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
As for the RTD build itself, optional but recommended:
- Resolve the 57 warnings. Example log: https://readthedocs.org/api/v2/build/18753466.txt
- To prevent future warnings creeping back it, set RTD build to fail on warning.
- To prevent bad cross-linking, set
nitpicky=Trueindocs/conf.pyand fix the broken refs. - To prevent bad URLs, run linkcheck once in a while (could be a cron job). There might be false positives sometimes.