CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="../../"> <head> <meta charset="utf-8" /> <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta property="og:title" content="How-to guides: build process" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://docs.readthedocs.io/en/stable/guides/build/index.html" /> <meta property="og:site_name" content="Read the Docs Documentation" /> <meta property="og:description" content="⏩️ Setup email notifications, Email notifications can alert you when your builds fail. This is the most simple way to monitor your documentation builds, it only requires you to switch it on.,, ⏩️ Setup webhook notifications, Webhook notifications can alert you when your builds fail so you can tak..." /> <meta property="og:image" content="https://docs.readthedocs.io/en/latest/_static/img/logo-opengraph.png" /> <meta property="og:image:alt" content="Read the Docs Documentation" /> <meta name="description" content="⏩️ Setup email notifications, Email notifications can alert you when your builds fail. This is the most simple way to monitor your documentation builds, it only requires you to switch it on.,, ⏩️ Setup webhook notifications, Webhook notifications can alert you when your builds fail so you can tak..." /> <meta name="twitter:card" content="summary_large_image" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>How-to guides: build process — Read the Docs user documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" /> <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.min.css?v=95c83b7e" /> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css?v=da32ccdd" /> <link rel="stylesheet" type="text/css" href="../../_static/css/sphinx_prompt_css.css?v=351d85e3" /> <link rel="canonical" href="https://docs.readthedocs.io/en/stable/guides/build/index.html" /> <script src="../../_static/jquery.js?v=5d32c60e"></script> <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../../_static/documentation_options.js?v=604cd17f"></script> <script src="../../_static/doctools.js?v=9bcbadda"></script> <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../../_static/copybutton.js?v=f281be69"></script> <script src="../../_static/design-tabs.js?v=f930bc37"></script> <script src="../../_static/js/expand_tabs.js?v=1e151f68"></script> <script src="../../_static/js/theme.js"></script> <script src="../../_static/js/versions.js"></script> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="How to setup email notifications" href="email-notifications.html" /> <link rel="prev" title="How to change the URL versioning scheme of your project" href="../setup/versioning-schemes.html" /> <script defer data-domain="docs.readthedocs.io" src="https://plausible.io/js/script.js"></script> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="docs" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/guides/build/index.html" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="../../index.html"> <img src="../../_static/logo.svg" class="logo" alt="Logo"/> </a> <div class="switch-menus"> <div class="version-switch"></div> <div class="language-switch"></div> </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption" role="heading"><span class="caption-text">Getting started</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../tutorial/index.html">Read the Docs tutorial</a></li> <li class="toctree-l1"><a class="reference internal" href="../../intro/doctools.html">Supported tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../../intro/mkdocs.html">Material for MkDocs</a></li> <li class="toctree-l1"><a class="reference internal" href="../../intro/sphinx.html">Sphinx</a></li> <li class="toctree-l1"><a class="reference internal" href="../../intro/markdoc.html">Markdoc</a></li> <li class="toctree-l1"><a class="reference internal" href="../../intro/add-project.html">Adding a documentation project</a></li> <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Example projects</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Project setup and configuration</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../config-file/index.html">Configuration file overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../config-file/v2.html">Configuration file reference</a></li> <li class="toctree-l1"><a class="reference internal" href="../../addons.html">Read the Docs Addons</a></li> <li class="toctree-l1"><a class="reference internal" href="../../automation-rules.html">Automation rules</a></li> <li class="toctree-l1"><a class="reference internal" href="../reproducible-builds.html">How to create reproducible builds</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Build process</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../builds.html">Build process overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../build-customization.html">Build process customization</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/git-integration.html">Git integration (GitHub, GitLab, Bitbucket)</a></li> <li class="toctree-l1"><a class="reference internal" href="../../pull-requests.html">Pull request previews</a></li> <li class="toctree-l1"><a class="reference internal" href="../../build-notifications.html">Build failure notifications</a></li> <li class="toctree-l1"><a class="reference internal" href="../../environment-variables.html">Environment variable overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/environment-variables.html">Environment variable reference</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Hosting documentation</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../versions.html">Versions</a></li> <li class="toctree-l1"><a class="reference internal" href="../../subprojects.html">Subprojects</a></li> <li class="toctree-l1"><a class="reference internal" href="../../localization.html">Localization and Internationalization</a></li> <li class="toctree-l1"><a class="reference internal" href="../../versioning-schemes.html">URL versioning schemes</a></li> <li class="toctree-l1"><a class="reference internal" href="../../custom-domains.html">Custom domains</a></li> <li class="toctree-l1"><a class="reference internal" href="../../doc-notifications.html">Documentation notifications</a></li> <li class="toctree-l1"><a class="reference internal" href="../../canonical-urls.html">Canonical URLs</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/cdn.html">Content Delivery Network (CDN) and caching</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/sitemaps.html">Sitemap support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/404-not-found.html"><code class="docutils literal notranslate"><span class="pre">404</span> <span class="pre">Not</span> <span class="pre">Found</span></code> pages</a></li> <li class="toctree-l1"><a class="reference internal" href="../../reference/robots.html"><code class="docutils literal notranslate"><span class="pre">robots.txt</span></code> support</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Reading documentation</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../downloadable-documentation.html">Offline formats (PDF, ePub, HTML)</a></li> <li class="toctree-l1"><a class="reference internal" href="../../doc-diff.html">DocDiff</a></li> <li class="toctree-l1"><a class="reference internal" href="../embedding-content.html">How to embed content from your documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../../server-side-search/index.html">Server side search</a></li> <li class="toctree-l1"><a class="reference internal" href="../../server-side-search/syntax.html">Search query syntax</a></li> <li class="toctree-l1"><a class="reference internal" href="../../flyout-menu.html">Flyout menu</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Maintaining projects</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../user-defined-redirects.html">Redirects</a></li> <li class="toctree-l1"><a class="reference internal" href="../../traffic-analytics.html">Traffic analytics</a></li> <li class="toctree-l1"><a class="reference internal" href="../../search-analytics.html">Search analytics</a></li> <li class="toctree-l1"><a class="reference internal" href="../../security-log.html">Security logs</a></li> <li class="toctree-l1"><a class="reference internal" href="../../badges.html">Status badges</a></li> <li class="toctree-l1"><a class="reference internal" href="../../explanation/documentation-structure.html">How to structure your documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../best-practice/links.html">Best practices for linking to your documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../../security-implications.html">Security considerations for documentation pages</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Business features</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../commercial/index.html">Business hosting</a></li> <li class="toctree-l1"><a class="reference internal" href="../../commercial/organizations.html">Organizations</a></li> <li class="toctree-l1"><a class="reference internal" href="../../commercial/single-sign-on.html">Single Sign-On (SSO)</a></li> <li class="toctree-l1"><a class="reference internal" href="../../commercial/sharing.html">Sharing private documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../../commercial/subscriptions.html">How to manage your subscription</a></li> <li class="toctree-l1"><a class="reference internal" href="../../commercial/privacy-level.html">Privacy Levels</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">How-to guides</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../setup/index.html">Project setup and configuration</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Build process</a><ul> <li class="toctree-l2"><a class="reference internal" href="email-notifications.html">Setup email notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="webhooks.html">Setup webhook notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="../pull-requests.html">Configuring pull request builds</a></li> <li class="toctree-l2"><a class="reference internal" href="../environment-variables.html">Using custom environment variables</a></li> <li class="toctree-l2"><a class="reference internal" href="../automation-rules.html">Managing versions automatically</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Upgrading and maintaining projects</a></li> <li class="toctree-l1"><a class="reference internal" href="../content/index.html">Content, themes and SEO</a></li> <li class="toctree-l1"><a class="reference internal" href="../access/index.html">Security and access</a></li> <li class="toctree-l1"><a class="reference internal" href="../management/index.html">Account management</a></li> <li class="toctree-l1"><a class="reference internal" href="../best-practice/index.html">Best practice</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting problems</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Reference</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../api/index.html">Public REST API</a></li> <li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently asked questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> <li class="toctree-l1"><a class="reference internal" href="../../about/index.html">About Read the Docs</a></li> <li class="toctree-l1"><a class="reference external" href="https://dev.readthedocs.io">Developer Documentation</a></li> <li class="toctree-l1"><a class="reference external" href="https://about.readthedocs.com">Read the Docs website</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../../index.html">Read the Docs user documentation</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">How-to guides: build process</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/readthedocs/readthedocs.org/blob/main/docs/user/guides/build/index.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="how-to-guides-build-process"> <h1>How-to guides: build process<a class="headerlink" href="#how-to-guides-build-process" title="Link to this heading"></a></h1> <dl class="simple"> <dt>⏩️ <a class="reference internal" href="email-notifications.html"><span class="doc">Setup email notifications</span></a></dt><dd><p>Email notifications can alert you when your builds fail. This is the most simple way to monitor your documentation builds, it only requires you to switch it on.</p> </dd> <dt>⏩️ <a class="reference internal" href="webhooks.html"><span class="doc">Setup webhook notifications</span></a></dt><dd><p>Webhook notifications can alert you when your builds fail so you can take immediate action. We show examples of how to use the webhooks on popular platforms like Slack and Discord.</p> </dd> <dt>⏩️ <a class="reference internal" href="../pull-requests.html"><span class="doc">Configuring pull request builds</span></a></dt><dd><p>Have your documentation built and access a preview for every <a class="reference internal" href="../../pull-requests.html"><span class="doc">pull request builds</span></a>.</p> </dd> <dt>⏩️ <a class="reference internal" href="../environment-variables.html"><span class="doc">Using custom environment variables</span></a></dt><dd><p>Extra environment variables, for instance secrets, may be needed in the build process and can be defined from the project’s <a class="reference internal" href="../../glossary.html#term-dashboard"><span class="xref std std-term">dashboard</span></a>.</p> </dd> <dt>⏩️ <a class="reference internal" href="../automation-rules.html"><span class="doc">Managing versions automatically</span></a></dt><dd><p>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.</p> </dd> </dl> <div class="toctree-wrapper compound"> </div> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="../setup/versioning-schemes.html" class="btn btn-neutral float-left" title="How to change the URL versioning scheme of your project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="email-notifications.html" class="btn btn-neutral float-right" title="How to setup email notifications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright Read the Docs, Inc & contributors.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>