...

Documentation projects on ReadTheDocs can be broken. This page is about how to fix them.

Getting the login

...

for ReadTheDocs

Ask Ned or Feanil to share the Keeper folder for the readthedocs.org login for the “edx” account.

...

Many doc projects don’t notify on failure. If you know how the owning team wants to be notified for failures, add the relevant e-mail address as a notification channel under ‘Admin’->'Notifications'

Build docs for pull requests

The best feedback is to use ReadTheDocs to build the docs for each pull request, with the result added as a check to the pull request.

• Create a .readthedocs.yml file (see below).

• Add a readthedocs webhook to the repo, and make sure it has the Pull requests events enabled.

• Enable Build pull requests for this project in the readthedocs settings.

Add doc builds to CI

Another approach is to build the docs as part of the GitHub Action CI. If you are using ReadTheDocs check, this isn’t needed.

Docs can often be built locally by going to the docs directory in the repo and running make html. Add this as a test to CI if the repo doesn’t already build docs as a part of CI.

...