ReadTheDocs build is broken #53

Activity

1. Jammy2211 commented on Nov 28, 2022

   

   Jammy2211

   on Nov 28, 2022

   Collaborator

   More actions

   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!

   PyAutoLabs/PyAutoHands#17

   👍React with 👍1Reacted by P. L. Lim
2. Jammy2211

   closed this as completedon Nov 28, 2022
3. pllim commented on Nov 28, 2022

   

   pllim

   on Nov 28, 2022

   ContributorAuthor

   More actions

   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:

   1. Resolve the 57 warnings. Example log: https://readthedocs.org/api/v2/build/18753466.txt
   2. To prevent future warnings creeping back it, set RTD build to fail on warning.
   3. To prevent bad cross-linking, set nitpicky=True in docs/conf.py and fix the broken refs.
   4. To prevent bad URLs, run linkcheck once in a while (could be a cron job). There might be false positives sometimes.