CINXE.COM
Read the Docs developer documentation — Read the Docs developer documentation
<!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="Read the Docs developer documentation" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://docs.readthedocs.com/dev/latest/index.html" /> <meta property="og:site_name" content="Read the Docs Documentation" /> <meta property="og:description" content="Documentation for running your own local version of Read the Docs for development, or taking the open source Read the Docs codebase for your own custom installation. General: Contributing to Read the Docs, Code of Conduct, Overview of issue labels, Roadmap, Design documents. Development: Developm..." /> <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="Documentation for running your own local version of Read the Docs for development, or taking the open source Read the Docs codebase for your own custom installation. General: Contributing to Read the Docs, Code of Conduct, Overview of issue labels, Roadmap, Design documents. Development: Developm..." /> <meta name="twitter:card" content="summary_large_image" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Read the Docs developer documentation — Read the Docs developer 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.com/dev/latest/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="Contributing to Read the Docs" href="contribute.html" /> <script defer data-domain="dev.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="dev" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><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="#"> <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">General</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing to Read the Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="code-of-conduct.html">Code of Conduct</a></li> <li class="toctree-l1"><a class="reference internal" href="issue-labels.html">Overview of issue labels</a></li> <li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li> <li class="toctree-l1"><a class="reference internal" href="design/index.html">Design documents</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Development</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="install.html">Development installation</a></li> <li class="toctree-l1"><a class="reference internal" href="guides/index.html">Development guides</a></li> <li class="toctree-l1"><a class="reference internal" href="design.html">Designing Read the Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="docs.html">Building and contributing to documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="style-guide.html">Documentation style guide</a></li> <li class="toctree-l1"><a class="reference internal" href="front-end.html">Front-end development</a></li> <li class="toctree-l1"><a class="reference internal" href="i18n.html">Internationalization</a></li> <li class="toctree-l1"><a class="reference internal" href="migrations.html">Database migrations</a></li> <li class="toctree-l1"><a class="reference internal" href="server-side-search.html">Server side search</a></li> <li class="toctree-l1"><a class="reference internal" href="search-integration.html">Server side search integration</a></li> <li class="toctree-l1"><a class="reference internal" href="subscriptions.html">Subscriptions</a></li> <li class="toctree-l1"><a class="reference internal" href="settings.html">Interesting settings</a></li> <li class="toctree-l1"><a class="reference internal" href="tests.html">Testing</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="#">Read the Docs developer 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="#" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Read the Docs developer documentation</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/readthedocs/readthedocs.org/blob/main/docs/dev/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="read-the-docs-developer-documentation"> <h1>Read the Docs developer documentation<a class="headerlink" href="#read-the-docs-developer-documentation" title="Link to this heading"></a></h1> <p>Documentation for running your own local version of Read the Docs for development, or taking the open source Read the Docs codebase for your own custom installation.</p> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">General</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing to Read the Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="code-of-conduct.html">Code of Conduct</a></li> <li class="toctree-l1"><a class="reference internal" href="issue-labels.html">Overview of issue labels</a></li> <li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li> <li class="toctree-l1"><a class="reference internal" href="design/index.html">Design documents</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Development</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="install.html">Development installation</a></li> <li class="toctree-l1"><a class="reference internal" href="guides/index.html">Development guides</a></li> <li class="toctree-l1"><a class="reference internal" href="design.html">Designing Read the Docs</a></li> <li class="toctree-l1"><a class="reference internal" href="docs.html">Building and contributing to documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="style-guide.html">Documentation style guide</a></li> <li class="toctree-l1"><a class="reference internal" href="front-end.html">Front-end development</a></li> <li class="toctree-l1"><a class="reference internal" href="i18n.html">Internationalization</a></li> <li class="toctree-l1"><a class="reference internal" href="migrations.html">Database migrations</a></li> <li class="toctree-l1"><a class="reference internal" href="server-side-search.html">Server side search</a></li> <li class="toctree-l1"><a class="reference internal" href="search-integration.html">Server side search integration</a></li> <li class="toctree-l1"><a class="reference internal" href="subscriptions.html">Subscriptions</a></li> <li class="toctree-l1"><a class="reference internal" href="settings.html">Interesting settings</a></li> <li class="toctree-l1"><a class="reference internal" href="tests.html">Testing</a></li> </ul> </div> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="contribute.html" class="btn btn-neutral float-right" title="Contributing to Read the Docs" 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>