How-to guides: build process

⏩️ Set up email notifications

Email notifications can alert you when your builds fail. This is the most simple way to monitor your documentation builds.

⏩️ Setting up outgoing webhooks

Outgoing webhooks can used to send updates on builds to other services. We show examples using webhooks to connect to popular platforms like Slack and Discord.

⏩️ Configuring pull request builds

Have your documentation built and access a preview for every pull request builds.

⏩️ Using custom environment variables

Extra environment variables, for instance secrets, may be needed in the build process and can be defined from the project’s dashboard.

⏩️ Managing versions automatically

Automating your versioning on Read the Docs means you only have to handle your versioning logic in Git. Learn how to define rules to automate creation of new versions on Read the Docs, entirely using your Git repository’s version logic.

⏩️ Skip or cancel builds based on conditions

Skip builds before they are triggered using automation rules, or cancel a running build from your own commands using the special exit code 183. This helps save resources by avoiding unnecessary documentation builds.

⏩️ Direct upload

Build your documentation in GitHub Actions or any other continuous integration service, and upload the result to Read the Docs for hosting.