Page Comparison

...

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

• Add a readthedocs webhook to the repo, and make sure it has the Pull requests events enabled in addition to the usual events (see below).

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

...

The docs might build fine when triggered manually, but not start builds automatically. This means you need to add or fix the webhook:

1. Visit the Admin - Integrations section of the project dashboard

2. You need a “GitHub incoming webhook.

...

1. ” If it’s not there, click “Add integration.”

2. Select “GitHub incoming webhook” from the Integration type dropdown.

3. ReadTheDocs will try to add the webhook to GitHub, but will likely fail (TODO: why?)

4. Copy the URL that starts “readthedocs.org/api/v2/…”

5. In GitHub, go to the repo Settings - Webhooks. Click “Add webhook”

6. Paste the URL you copied into the Payload URL. Make sure it starts with “https://”

7. Choose “Let me select individual events” then choose these events:

   1. Branch or tag creation

   2. Branch or tag deletion

   3. Pull requests

   4. Pushes

8. Finish with “Add webhook”