CINXE.COM
Sphinx — Sphinx documentation
<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Sphinx — Sphinx documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5c69cfe2" /> <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" /> <link rel="stylesheet" type="text/css" href="_static/sphinx13.css?v=ba1752c5" /> <script src="_static/documentation_options.js?v=15c97ff8"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="canonical" href="https://www.sphinx-doc.org/en/master/index.html" /> <link rel="search" type="application/opensearchdescription+xml" title="Search within Sphinx documentation" href="_static/opensearch.xml"/> <link rel="icon" href="_static/favicon.svg"/> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Installing Sphinx" href="usage/installation.html" /> <style>.related { display: none; }</style> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="sphinx" /><meta name="readthedocs-version-slug" content="master" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head><body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="github" viewBox="0 0 16 16"> <title>GitHub</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16" > <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z" ></path> </svg> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> </svg> <div class="pageheader"> <div class="brand"> <a href="#"> <img src="_static/sphinx-logo.svg" alt="logo" /> <span>Sphinx</span> </a> </div> <div class="icons"> <a href="https://github.com/sphinx-doc/sphinx" title="Source Code" target="_blank"> <svg><use href="#github"></use></svg> </a> </div> </div> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li><a href="#">Documentation</a> »</li> <li class="nav-item nav-item-this"><a href="">Sphinx</a></li> </ul> </div> <div class="document"> <div class="sphinxsidebar" role="navigation" aria-label="Main"> <search id="searchbox" style="display: none" role="search"> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> <input type="submit" value="Go" /> </form> </div> </search> <script>document.getElementById('searchbox').style.display = "block"</script> <div class="sphinxsidebar-navigation__contents"> <h3>On this page</h3> <ul> <li><a class="reference internal" href="#">Sphinx</a><ul> <li><a class="reference internal" href="#get-started">Get started</a></li> <li><a class="reference internal" href="#user-guide">User guide</a></li> <li><a class="reference internal" href="#community-guide">Community guide</a></li> <li><a class="reference internal" href="#reference-guide">Reference guide</a></li> </ul> </li> </ul> </div> <div class="sphinxsidebar-navigation__pages"> <p class="caption" role="heading"><span class="caption-text">The Basics</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installing Sphinx</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Getting started</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Build your first project</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">User guide</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Using Sphinx</a></li> <li class="toctree-l1"><a class="reference internal" href="development/index.html">Extending Sphinx</a></li> <li class="toctree-l1"><a class="reference internal" href="extdev/index.html">Sphinx API</a></li> <li class="toctree-l1"><a class="reference internal" href="latex.html">LaTeX customization</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Community</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="support.html">Get support</a></li> <li class="toctree-l1"><a class="reference internal" href="internals/index.html">Contribute to Sphinx</a></li> <li class="toctree-l1"><a class="reference internal" href="faq.html">Sphinx FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="authors.html">Sphinx authors</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="man/index.html">Command-line tools</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/extensions/index.html">Extensions</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/restructuredtext/index.html">reStructuredText</a></li> <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="changes/index.html">Changelog</a></li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Projects using Sphinx</a></li> </ul> </div> </div> <div class="body" role="main"> <section id="sphinx"> <h1>Sphinx<a class="headerlink" href="#sphinx" title="Link to this heading">¶</a></h1> <blockquote class="epigraph sphinx-tagline"> <div><p>Create intelligent and beautiful documentation with ease</p> </div></blockquote> <div class="sphinx-features docutils container"> <div class="sphinx-feature admonition"> <p class="admonition-title">📝 Rich Text Formatting</p> <p>Author in <a class="reference internal" href="usage/restructuredtext/basics.html#rst-primer"><span class="std std-ref">reStructuredText</span></a> or <a class="reference internal" href="usage/markdown.html#markdown"><span class="std std-ref">MyST Markdown</span></a> to create highly structured technical documents, including tables, highlighted code blocks, mathematical notations, and more.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🔗 Powerful Cross-Referencing</p> <p>Create <a class="reference internal" href="usage/referencing.html#xref"><span class="std std-ref">cross-references</span></a> within your project, and even across <a class="reference internal" href="usage/extensions/intersphinx.html#ext-intersphinx"><span class="std std-ref">different projects</span></a>. Include references to sections, figures, tables, citations, glossaries, code objects, and more.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">📚 Versatile Documentation Formats</p> <p>Generate documentation in the preferred formats of your audience, including HTML, LaTeX (for PDF), ePub, Texinfo, <a class="reference internal" href="usage/builders/index.html#builders"><span class="std std-ref">and more</span></a>.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🎨 Extensive Theme Support</p> <p>Create visually appealing documentation, with a wide choice of <a class="reference internal" href="usage/theming.html#builtin-themes"><span class="std std-ref">built-in</span></a> and <a class="reference internal" href="usage/theming.html#third-party-themes"><span class="std std-ref">third-party</span></a> HTML themes and the ability to customize or <a class="reference internal" href="development/html_themes/index.html#extension-html-theme"><span class="std std-ref">create new themes</span></a>.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🔌 Fully Extensible</p> <p>Add custom functionality, via robust <a class="reference internal" href="development/index.html#extending-sphinx"><span class="std std-ref">extension mechanisms</span></a> with numerous <a class="reference internal" href="usage/extensions/index.html#builtin-extensions"><span class="std std-ref">built-in</span></a> and <a class="reference internal" href="usage/extensions/index.html#third-party-extensions"><span class="std std-ref">third-party</span></a> extensions available for tasks like creating diagrams, testing code, and more.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🛠️ Automatic API Documentation</p> <p>Generate API documentation for Python, C++ and other <a class="reference internal" href="usage/domains/index.html#usage-domains"><span class="std std-ref">software domains</span></a>, manually or <a class="reference internal" href="usage/extensions/autodoc.html#ext-autodoc"><span class="std std-ref">automatically from docstrings</span></a>, ensuring your code documentation stays up-to-date with minimal effort.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🌍 Internationalization (i18n)</p> <p>Add documentation <a class="reference internal" href="usage/advanced/intl.html#intl"><span class="std std-ref">translations</span></a> multiple languages to reach a global audience.</p> </div> <div class="sphinx-feature admonition"> <p class="admonition-title">🌟 Active Community and Support</p> <p>Benefit from an <a class="reference internal" href="support.html#support-index"><span class="std std-ref">active community</span></a>, with numerous resources, tutorials, forums, and examples.</p> </div> </div> <hr class="docutils" /> <div class="sphinx-users docutils container"> <p>As used by:</p> <div class="sphinx-users-logos docutils container"> <figure class="align-center" id="id2"> <a class="reference external image-reference" href="https://docs.python.org"><img alt="Python Logo" src="_images/python-logo.png" style="height: 100px;" /> </a> <figcaption> <p><span class="caption-text">Python</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p> </figcaption> </figure> <figure class="align-center" id="id3"> <a class="reference external image-reference" href="https://docs.kernel.org/"><img alt="Linux Logo" src="_images/linux-logo.png" style="height: 100px;" /> </a> <figcaption> <p><span class="caption-text">Linux Kernel</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p> </figcaption> </figure> <figure class="align-center" id="id4"> <a class="reference external image-reference" href="https://docs.jupyter.org"><img alt="Jupyter Logo" src="_images/jupyter-logo.png" style="height: 100px;" /> </a> <figcaption> <p><span class="caption-text">Project Jupyter</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p> </figcaption> </figure> </div> </div> <hr class="docutils" /> <p>See below for how to navigate Sphinx’s documentation.</p> <div class="admonition seealso"> <p class="admonition-title">See also</p> <p>The <a class="reference external" href="contents.html">Sphinx documentation Table of Contents</a> has a full list of this site’s pages.</p> </div> <section id="get-started"> <span id="id1"></span><h2>Get started<a class="headerlink" href="#get-started" title="Link to this heading">¶</a></h2> <p>These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.</p> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">The Basics</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installing Sphinx</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#pypi-package">PyPI package</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#conda-package">Conda package</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#os-specific-package-manager">OS-specific package manager</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#docker">Docker</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#installation-of-the-latest-development-release">Installation of the latest development release</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#installation-from-source">Installation from source</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Getting started</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#setting-up-the-documentation-sources">Setting up the documentation sources</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#defining-document-structure">Defining document structure</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#adding-content">Adding content</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#running-the-build">Running the build</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#documenting-objects">Documenting objects</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#basic-configuration">Basic configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#autodoc">Autodoc</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#intersphinx">Intersphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/quickstart.html#more-topics-to-be-covered">More topics to be covered</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Build your first project</a><ul> <li class="toctree-l2"><a class="reference internal" href="tutorial/getting-started.html">Getting started</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/first-steps.html">First steps to document your project using Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/more-sphinx-customization.html">More Sphinx customization</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/narrative-documentation.html">Narrative documentation in Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/describing-code.html">Describing code in Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/automatic-doc-generation.html">Automatic documentation generation from code</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/deploying.html">Appendix: Deploying a Sphinx project online</a></li> <li class="toctree-l2"><a class="reference internal" href="tutorial/end.html">Where to go from here</a></li> </ul> </li> </ul> </div> </section> <section id="user-guide"> <span id="user-guides"></span><h2>User guide<a class="headerlink" href="#user-guide" title="Link to this heading">¶</a></h2> <p>These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx. If you are new to Sphinx, we recommend starting with <a class="reference internal" href="#get-started"><span class="std std-ref">Get started</span></a>.</p> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">User guide</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Using Sphinx</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/restructuredtext/index.html">reStructuredText</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/markdown.html">Markdown</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/referencing.html">Cross-references</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/builders/index.html">Builders</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/domains/index.html">Domains</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/extensions/index.html">Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/theming.html">HTML theming</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/advanced/intl.html">Internationalization</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/advanced/websupport/index.html">Sphinx Web Support</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="development/index.html">Extending Sphinx</a><ul> <li class="toctree-l2"><a class="reference internal" href="development/tutorials/index.html">Tutorials</a></li> <li class="toctree-l2"><a class="reference internal" href="development/howtos/index.html">How-tos</a></li> <li class="toctree-l2"><a class="reference internal" href="development/html_themes/index.html">HTML theme development</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="extdev/index.html">Sphinx API</a><ul> <li class="toctree-l2"><a class="reference internal" href="extdev/index.html#important-objects">Important objects</a></li> <li class="toctree-l2"><a class="reference internal" href="extdev/index.html#build-phases">Build phases</a></li> <li class="toctree-l2"><a class="reference internal" href="extdev/index.html#extension-metadata">Extension metadata</a></li> <li class="toctree-l2"><a class="reference internal" href="extdev/index.html#apis-used-for-writing-extensions">APIs used for writing extensions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="latex.html">LaTeX customization</a><ul> <li class="toctree-l2"><a class="reference internal" href="latex.html#the-latex-elements-configuration-setting">The <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code> configuration setting</a></li> <li class="toctree-l2"><a class="reference internal" href="latex.html#the-sphinxsetup-configuration-setting">The <code class="docutils literal notranslate"><span class="pre">sphinxsetup</span></code> configuration setting</a></li> <li class="toctree-l2"><a class="reference internal" href="latex.html#additional-css-like-sphinxsetup-keys">Additional CSS-like <code class="docutils literal notranslate"><span class="pre">'sphinxsetup'</span></code> keys</a></li> <li class="toctree-l2"><a class="reference internal" href="latex.html#latex-macros-and-environments">LaTeX macros and environments</a></li> </ul> </li> </ul> </div> </section> <section id="community-guide"> <h2>Community guide<a class="headerlink" href="#community-guide" title="Link to this heading">¶</a></h2> <p>Sphinx is community supported and welcomes contributions from anybody. The sections below should help you get started joining the Sphinx community as well as contributing.</p> <p>See the <a class="reference internal" href="internals/contributing.html"><span class="doc">Sphinx contributors’ guide</span></a> if you would like to contribute to the project.</p> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Community</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="support.html">Get support</a></li> <li class="toctree-l1"><a class="reference internal" href="internals/index.html">Contribute to Sphinx</a><ul> <li class="toctree-l2"><a class="reference internal" href="internals/contributing.html">Contributing to Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="internals/release-process.html">Sphinx’s release process</a></li> <li class="toctree-l2"><a class="reference internal" href="internals/organization.html">Organization of the Sphinx project</a></li> <li class="toctree-l2"><a class="reference internal" href="internals/code-of-conduct.html">Sphinx Code of Conduct</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="faq.html">Sphinx FAQ</a><ul> <li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i">How do I…</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#using-sphinx-with">Using Sphinx with…</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#sphinx-vs-docutils">Sphinx vs. Docutils</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#epub-info">Epub info</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#texinfo-info">Texinfo info</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="authors.html">Sphinx authors</a><ul> <li class="toctree-l2"><a class="reference internal" href="authors.html#maintainers">Maintainers</a></li> <li class="toctree-l2"><a class="reference internal" href="authors.html#contributors">Contributors</a></li> <li class="toctree-l2"><a class="reference internal" href="authors.html#former-maintainers">Former maintainers</a></li> </ul> </li> </ul> </div> </section> <section id="reference-guide"> <h2>Reference guide<a class="headerlink" href="#reference-guide" title="Link to this heading">¶</a></h2> <p>Reference documentation is more complete and programmatic in nature, it is a collection of information that can be quickly referenced. If you would like usecase-driven documentation, see <a class="reference internal" href="#get-started"><span class="std std-ref">Get started</span></a> or <a class="reference internal" href="#user-guides"><span class="std std-ref">User guide</span></a>.</p> <div class="toctree-wrapper compound"> <p class="caption" role="heading"><span class="caption-text">Reference</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="man/index.html">Command-line tools</a><ul> <li class="toctree-l2"><a class="reference internal" href="man/index.html#core-applications">Core applications</a></li> <li class="toctree-l2"><a class="reference internal" href="man/index.html#additional-applications">Additional applications</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/configuration.html">Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#project-tags">Project tags</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#project-information">Project information</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#general-configuration">General configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#builder-options">Builder options</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#domain-options">Domain options</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#extension-options">Extension options</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/configuration.html#example-configuration-file">Example configuration file</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/extensions/index.html">Extensions</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/extensions/index.html#built-in-extensions">Built-in extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/extensions/index.html#third-party-extensions">Third-party extensions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/restructuredtext/index.html">reStructuredText</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/restructuredtext/basics.html">reStructuredText Primer</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/restructuredtext/roles.html">Roles</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/restructuredtext/directives.html">Directives</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/restructuredtext/field-lists.html">Field Lists</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="changes/index.html">Changelog</a><ul> <li class="toctree-l2"><a class="reference internal" href="changes/index.html#release-8-2-0-released-feb-18-2025">Release 8.2.0 (released Feb 18, 2025)</a></li> <li class="toctree-l2"><a class="reference internal" href="changes/index.html#prior-releases">Prior releases</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Projects using Sphinx</a><ul> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-alabaster-theme">Documentation using the alabaster theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-classic-theme">Documentation using the classic theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-sphinxdoc-theme">Documentation using the sphinxdoc theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-nature-theme">Documentation using the nature theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-another-builtin-theme">Documentation using another builtin theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-read-the-docs-sphinx-theme">Documentation using Read the Docs Sphinx Theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-sphinx-bootstrap-theme">Documentation using Sphinx Bootstrap Theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-pydata-sphinx-theme">Documentation using PyData Sphinx Theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-furo-theme">Documentation using Furo theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-a-custom-theme-or-integrated-in-a-website">Documentation using a custom theme or integrated in a website</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#homepages-and-other-non-documentation-sites">Homepages and other non-documentation sites</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#books-produced-using-sphinx">Books produced using Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#theses-produced-using-sphinx">Theses produced using Sphinx</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#projects-integrating-sphinx-functionality">Projects integrating Sphinx functionality</a></li> </ul> </li> </ul> </div> </section> </section> <div class="related-pages" role="navigation" aria-label="Related"> <div></div> <a class="next-page" href="usage/installation.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> <div class="title">Installing Sphinx</div> </div> <svg><use href="#svg-arrow-right"></use></svg> </a> </div> </div> </div> <div class="footer" role="contentinfo"> © Copyright 2007-2025, the Sphinx developers. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.0. </div> </body> </html>