CINXE.COM
Read the Docs Sphinx Theme — Read the Docs Sphinx Theme 3.0.2 documentation
<!DOCTYPE html> <html class="writer-html5" lang="en"> <head> <meta charset="utf-8" /> <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Read the Docs Sphinx Theme — Read the Docs Sphinx Theme 3.0.2 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="shortcut icon" href="_static/favicon.ico"/> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=1d3d97ce"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=4825356b"></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="Installation" href="installing.html" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="sphinx-rtd-theme" /><meta name="readthedocs-version-slug" content="stable" /><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-wordmark-light.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">Theme Documentation</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="installing.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="configuring.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Demo Documentation</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="demo/structure.html">1. Structural Elements</a></li> <li class="toctree-l1"><a class="reference internal" href="demo/structure.html#structural-elements-2">2. Structural Elements 2</a></li> <li class="toctree-l1"><a class="reference internal" href="demo/demo.html">3. Paragraph Level Markup</a></li> <li class="toctree-l1"><a class="reference internal" href="demo/lists_tables.html">4. Lists & Tables</a></li> <li class="toctree-l1"><a class="reference internal" href="demo/api.html">5. API documentation and generated content</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">This is an incredibly long caption for a long menu</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="demo/long.html">1. Long Sticky Nav</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Breadcrumbs</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="demo/level1/index.html">Breadcrumb Level 1</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 Sphinx Theme</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 Sphinx Theme</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</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-sphinx-theme"> <h1>Read the Docs Sphinx Theme<a class="headerlink" href="#read-the-docs-sphinx-theme" title="Permalink to this heading"></a></h1> <p>This <a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a> theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is commonly used with projects on <a class="reference external" href="http://www.readthedocs.org">Read the Docs</a> but can work with any Sphinx project.</p> <section id="using-this-theme"> <h2>Using this theme<a class="headerlink" href="#using-this-theme" title="Permalink to this heading"></a></h2> <dl class="simple"> <dt><a class="reference internal" href="installing.html"><span class="doc">Installation</span></a></dt><dd><p>How to install this theme on your Sphinx project.</p> </dd> <dt><a class="reference internal" href="configuring.html"><span class="doc">Configuration</span></a></dt><dd><p>Theme configuration and customization options.</p> </dd> <dt><a class="reference internal" href="development.html#supported-browsers"><span class="std std-ref">Supported browsers</span></a></dt><dd><p>Supported browser/operating system combinations.</p> </dd> <dt><a class="reference internal" href="development.html#supported-dependencies"><span class="std std-ref">Supported dependencies</span></a></dt><dd><p>Supported project dependencies, like Python and Sphinx.</p> </dd> </dl> </section> <section id="development"> <h2>Development<a class="headerlink" href="#development" title="Permalink to this heading"></a></h2> <dl class="simple"> <dt><a class="reference internal" href="contributing.html"><span class="doc">Contributing</span></a></dt><dd><p>How to contribute changes to the theme.</p> </dd> <dt><a class="reference internal" href="development.html"><span class="doc">Development guidelines</span></a></dt><dd><p>Guidelines the theme developers use for developing and testing changes.</p> </dd> <dt><a class="reference external" href="https://docs.readthedocs.io/en/stable/contribute.html">Read the Docs contributor guide</a></dt><dd><p>Our contribution guidelines extend to all projects maintained by Read the Docs core team.</p> </dd> <dt><a class="reference internal" href="changelog.html"><span class="doc">Changelog</span></a></dt><dd><p>The theme development changelog.</p> </dd> <dt><a class="reference internal" href="demo/structure.html"><span class="doc">Demo documentation</span></a></dt><dd><p>The theme’s styleguide test environment, where new changes are tested.</p> </dd> </dl> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Breadcrumbs</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="demo/level1/index.html">Breadcrumb Level 1</a><ul> <li class="toctree-l2"><a class="reference internal" href="demo/level1/level2/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Breadcrumb</span> <span class="pre">Level</span> <span class="pre">2</span></code></a><ul> <li class="toctree-l3"><a class="reference internal" href="demo/level1/level2/level3/index.html">Breadcrumb Level 3</a></li> </ul> </li> </ul> </li> </ul> </div> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="installing.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright Dave Snider, 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>