The PyData Sphinx Theme — PyData Theme 0.16.1 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" /> <meta content="Top-level documentation for pydata-sphinx theme, with links to the rest of the site.. " lang="en" name="description" xml:lang="en" /> <link href="_static/favicon-32x32.png" sizes="32x32" rel="icon" type="image/png"> <link href="_static/favicon-16x16.png" sizes="16x16" rel="icon" type="image/png"> <link rel="shortcut icon" sizes="any" href="_static/favicon.ico" type="image/x-icon"> <link href="_static/android-chrome-192x192.png" sizes="192x192" rel="icon" type="image/png"> <link rel="mask-icon" color="#459db9" href="_static/safari-pinned-tab.svg" type="image/svg+xml"> <link rel="apple-touch-icon" href="_static/apple-touch-icon.png" sizes="180x180" type="image/png"> <meta name="msapplication-TileColor" content="#459db9"> <meta name="theme-color" content="#ffffff"> <meta name="msapplication-TileImage" content="mstile-150x150.png"> <title>The PyData Sphinx Theme — PyData Theme 0.16.1 documentation</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; </script>  <noscript> <style> .pst-js-only { display: none !important; } </style> </noscript>  <link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" /> <link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" /> <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="_static/jupyter-sphinx.css" /> <link rel="stylesheet" type="text/css" href="_static/thebelab.css" /> <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" /> <link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" /> <link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=ca70e7f1" /> <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" /> <link rel="stylesheet" type="text/css" href="_static/custom.css?v=b83be735" />  <script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" /> <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" /> <script src="_static/documentation_options.js?v=179565df"></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=18a8d5f5"></script> <script src="_static/thebelab-helper.js"></script> <script src="_static/jupyterlite_sphinx.js?v=d6bdf5f8"></script> <script>let toggleHintShow = 'Click to expand';</script> <script>let toggleHintHide = 'Click to collapse';</script> <script>let toggleOpenOnPrint = 'true';</script> <script src="_static/togglebutton.js?v=4a39c7ea"></script> <script src="_static/design-tabs.js?v=f930bc37"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script> <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\$", "\$"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script> <script> DOCUMENTATION_OPTIONS.theme_version = '0.16.1'; DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://pydata-sphinx-theme.readthedocs.io/en/latest/_static/switcher.json'; DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'v0.16.1'; DOCUMENTATION_OPTIONS.show_version_warning_banner = true; </script> <script src="_static/pydata-icon.js?v=f63c87bd"></script> <script src="_static/custom-icon.js?v=74687d30"></script> <link rel="icon" href="_static/logo.svg"/> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="User Guide" href="user_guide/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <meta name="docsearch:language" content="en"/> <meta name="docsearch:version" content="" /> <meta name="docbuild:last-update" content="Dec 17, 2024"/> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="pydata-sphinx-theme" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/index.html" /><meta name="readthedocs-http-status" content="200" /></head> <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> <div id="pst-scroll-pixel-helper"></div> <button type="button" class="btn rounded-pill" id="pst-back-to-top"> <i class="fa-solid fa-arrow-up"></i>Back to top</button> <dialog id="pst-search-dialog"> <form class="bd-search d-flex align-items-center" action="search.html" method="get"> <i class="fa-solid fa-magnifying-glass"></i> <input type="search" class="form-control" name="q" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> </form> </dialog> <div class="pst-async-banner-revealer d-none"> <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> <aside class="bd-header-announcement d-print-none d-none" aria-label="Announcement" data-pst-announcement-url="https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html"></aside> </div> <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> <div class="bd-header__inner bd-page-width"> <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation"> <span class="fa-solid fa-bars"></span> </button> <div class=" navbar-header-items__start"> <div class="navbar-item"> <a class="navbar-brand logo" href="#"> <img src="_static/logo.svg" class="logo__image only-light" alt=""/> <img src="_static/logo-dark.svg" class="logo__image only-dark pst-js-only" alt=""/> <p class="title logo__title">PyData Theme</p> </a></div> </div> <div class=" navbar-header-items"> <div class="me-auto navbar-header-items__center"> <div class="navbar-item"> <div class="version-switcher__container dropdown pst-js-only"> <button id="pst-version-switcher-button-2" type="button" class="version-switcher__button btn btn-sm dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="pst-version-switcher-list-2" aria-label="Version switcher list" > Choose version  <span class="caret"></span> </button> <div id="pst-version-switcher-list-2" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="pst-version-switcher-button-2">  </div> </div></div> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/index.html"> User Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="community/index.html"> Contributor Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="examples/index.html"> Examples </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://github.com/pydata/pydata-sphinx-theme/releases"> Changelog </a> </li> <li class="nav-item dropdown"> <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> More </button> <ul id="pst-nav-more-links" class="dropdown-menu"> <li class=" "> <a class="nav-link dropdown-item nav-internal" href="api/index.html"> API </a> </li> <li class=" "> <a class="nav-link dropdown-item nav-external" href="https://pydata.org"> PyData Website </a> </li> <li class=" "> <a class="nav-link dropdown-item nav-external" href="https://numfocus.org/"> NumFocus </a> </li> <li class=" "> <a class="nav-link dropdown-item nav-external" href="https://numfocus.org/donate"> Donate to NumFocus </a> </li> </ul> </li> </ul> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> <div class="navbar-item"><ul class="navbar-icon-links" aria-label="Icon Links"> <li class="nav-item"> <a href="https://x.com/PyData" title="X" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-x-twitter fa-lg" aria-hidden="true"></i> <span class="sr-only">X</span></a> </li> <li class="nav-item"> <a href="https://github.com/pydata/pydata-sphinx-theme" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a href="https://pypi.org/project/pydata-sphinx-theme" title="PyPI" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-custom fa-pypi fa-lg" aria-hidden="true"></i> <span class="sr-only">PyPI</span></a> </li> <li class="nav-item"> <a href="https://pydata.org" title="PyData" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-custom fa-pydata fa-lg" aria-hidden="true"></i> <span class="sr-only">PyData</span></a> </li> </ul></div> </div> </div> <div class="navbar-persistent--mobile"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> </div> </header> <div class="bd-container"> <div class="bd-container__inner bd-page-width"> <dialog id="pst-primary-sidebar-modal"></dialog> <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide"> <div class="sidebar-header-items sidebar-primary__section"> <div class="sidebar-header-items__center"> <div class="navbar-item"> <div class="version-switcher__container dropdown pst-js-only"> <button id="pst-version-switcher-button-3" type="button" class="version-switcher__button btn btn-sm dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="pst-version-switcher-list-3" aria-label="Version switcher list" > Choose version  <span class="caret"></span> </button> <div id="pst-version-switcher-list-3" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="pst-version-switcher-button-3">  </div> </div></div> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/index.html"> User Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="community/index.html"> Contributor Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="examples/index.html"> Examples </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://github.com/pydata/pydata-sphinx-theme/releases"> Changelog </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="api/index.html"> API </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://pydata.org"> PyData Website </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://numfocus.org/"> NumFocus </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://numfocus.org/donate"> Donate to NumFocus </a> </li> </ul> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> <div class="navbar-item"><ul class="navbar-icon-links" aria-label="Icon Links"> <li class="nav-item"> <a href="https://x.com/PyData" title="X" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-x-twitter fa-lg" aria-hidden="true"></i> <span class="sr-only">X</span></a> </li> <li class="nav-item"> <a href="https://github.com/pydata/pydata-sphinx-theme" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a href="https://pypi.org/project/pydata-sphinx-theme" title="PyPI" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-custom fa-pypi fa-lg" aria-hidden="true"></i> <span class="sr-only">PyPI</span></a> </li> <li class="nav-item"> <a href="https://pydata.org" title="PyData" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-custom fa-pydata fa-lg" aria-hidden="true"></i> <span class="sr-only">PyData</span></a> </li> </ul></div> </div> </div> <div class="sidebar-primary-items__end sidebar-primary__section"> <div class="sidebar-primary-item"> <div id="ethical-ad-placement" class="flat" data-ea-publisher="readthedocs" data-ea-type="readthedocs-sidebar" data-ea-manual="true"> </div></div> </div> </div> <main id="main-content" class="bd-main" role="main"> <div class="bd-content"> <div class="bd-article-container"> <div class="bd-header-article d-print-none"></div> <div id="searchbox"></div> <article class="bd-article"> <section id="the-pydata-sphinx-theme"> <h1>The PyData Sphinx Theme<a class="headerlink" href="#the-pydata-sphinx-theme" title="Link to this heading">#</a></h1> <p>A clean, Bootstrap-based Sphinx theme by and for <a class="reference external" href="https://pydata.org">the PyData community</a>.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 gallery-directive docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-2 sd-g-xs-2 sd-g-sm-2 sd-g-md-2 sd-g-lg-2 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fab fa-bootstrap pst-color-primary"></span> Built with Bootstrap</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Use Bootstrap classes and functionality in your documentation.</p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fas fa-bolt pst-color-primary"></span> Responsive Design</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Site sections will change behavior and size at different screen sizes.</p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fas fa-circle-half-stroke pst-color-primary"></span> Light / Dark theme</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Users can toggle between light and dark themes interactively.</p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fas fa-palette pst-color-primary"></span> Customizable UI and themes</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">Customize colors and branding with CSS variables, and build custom UIs with <a class="reference internal" href="user_guide/web-components.html"><span class="doc std std-doc">Sphinx Design components</span></a>.</p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fab fa-python pst-color-primary"></span> Supports PyData and Jupyter</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">CSS and UI support for <a class="reference internal" href="examples/execution.html"><span class="doc std std-doc">Jupyter extensions</span></a> and <a class="reference internal" href="examples/pydata.html"><span class="std std-doc">PyData execution outputs</span></a>.</p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <p class="sd-card-text"><span class="fas fa-lightbulb pst-color-primary"></span> Example Gallery</p> </div> <div class="sd-card-body docutils"> <p class="sd-card-text">See <a class="reference internal" href="examples/gallery.html"><span class="std std-doc">our gallery</span></a> of projects that use this theme.</p> </div> </div> </div> </div> </div> <div class="admonition seealso"> <p class="admonition-title">See also</p> <p>If you are looking for a Sphinx theme that puts all of its sub-pages in the sidebar, the <a class="reference external" href="https://sphinx-book-theme.readthedocs.io/">Sphinx Book Theme</a> has a similar look and feel, and <a class="reference external" href="https://pradyunsg.me/furo/quickstart/">Furo</a> is another excellent choice. You can also see the <a class="reference external" href="https://sphinx-themes.org">Sphinx Themes Gallery</a> for more ideas.</p> </div> <section id="user-guide"> <h2>User Guide<a class="headerlink" href="#user-guide" title="Link to this heading">#</a></h2> <p>Information about using, configuration, and customizing this theme.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/index.html">User Guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="user_guide/install.html">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/layout.html">Theme Structure and Layout</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/navigation.html">Navigation depth and collapsing sidebars</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/page-toc.html">Page Table of Contents</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/header-links.html">Header links</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/source-buttons.html">Source Buttons</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/indices.html">Sphinx indices</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/announcements.html">Announcement banners</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/version-dropdown.html">Version switcher dropdowns</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/search.html">Search bar / search button</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/keyboard-shortcuts.html">Keyboard shortcuts</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/i18n.html">Internationalization</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/back-to-top.html">Back to Top button</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/theme-elements.html">Theme-specific elements</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/ablog.html">Blogs with <code class="docutils literal notranslate"><span class="pre">ABlog</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/web-components.html">Sphinx Design Components</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/extending.html">Extending the theme</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/branding.html">Branding and logo</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/styling.html">Theme variables and CSS</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/fonts.html">Fonts and FontAwesome</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/light-dark.html">Light and dark themes</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/accessibility.html">Accessibility</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/analytics.html">Analytics and usage services</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/static_assets.html">Add custom CSS and JS assets</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/performance.html">Build performance and size</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/warnings.html">Theme changes, deprecations, and warnings</a></li> <li class="toctree-l2"><a class="reference internal" href="user_guide/readthedocs.html">Read the Docs functionality</a></li> </ul> </li> </ul> </div> </section> <section id="community-and-contribution-guide"> <h2>Community and contribution guide<a class="headerlink" href="#community-and-contribution-guide" title="Link to this heading">#</a></h2> <p>Information about the community behind this theme and how you can contribute.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="community/index.html">Contributor Guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="community/setup.html">Get started with development</a></li> <li class="toctree-l2"><a class="reference internal" href="community/structure.html">Structure of this theme</a></li> <li class="toctree-l2"><a class="reference internal" href="community/topics/index.html">Topic guides</a></li> <li class="toctree-l2"><a class="reference internal" href="community/practices/merge.html">Merge and review policy</a></li> <li class="toctree-l2"><a class="reference internal" href="community/practices/release.html">Making releases</a></li> <li class="toctree-l2"><a class="reference internal" href="community/practices/versions.html">Supported Python and Sphinx versions</a></li> <li class="toctree-l2"><a class="reference internal" href="community/contributors.html">Contributors to this theme</a></li> <li class="toctree-l2"><a class="reference internal" href="community/inspiration.html">Inspiration for design and UX</a></li> <li class="toctree-l2"><a class="reference internal" href="community/design-system.html">PyData Sphinx Theme Design System</a></li> </ul> </li> </ul> </div> </section> <section id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">#</a></h2> <p>Several example pages to demonstrate the functionality of this theme when used alongside other Sphinx extensions.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="examples/index.html">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="examples/gallery.html">Gallery of sites using this theme</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/kitchen-sink/index.html">Kitchen Sink</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/pydata.html">PyData Library Styles</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/execution.html">Execution Libraries</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/graphviz.html">Graphviz</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/no-sidebar.html">1. Test of no sidebar</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/persistent-search-field.html">2. Test of persistent search field</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/in-page-toc.html">3. Test of in-page TOC with no right sidebar</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/subpages/index.html">4. Section to show off pages with many sub pages</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/mult_headers.html">5. Top-level headers and the TOC</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/mult_headers.html#an-example-with-multiple-top-level-headers">6. An example with multiple top-level headers</a></li> <li class="toctree-l2"><a class="reference internal" href="examples/mult_headers.html#an-example-with-a-single-top-level-header">7. An example with a single top-level header</a></li> <li class="toctree-l2"><a class="reference external" href="https://jupyterbook.org/">Link to an external site</a></li> </ul> </li> </ul> </div> <div class="toctree-wrapper compound"> </div> </section> <section id="api"> <h2>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h2> <p>The content of the exposed <code class="docutils literal notranslate"><span class="pre">pydata_sphinx_theme</span></code> API.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="api/index.html">API</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/pydata_sphinx_theme/index.html">pydata_sphinx_theme</a></li> </ul> </li> </ul> </div> </section> </section> <div class="section ablog__blog_comments"> </div> </article> <footer class="prev-next-footer d-print-none"> <div class="prev-next-area"> <a class="right-next" href="user_guide/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">User Guide</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> </div> <footer class="bd-footer-content"> </footer> </main> </div> </div>  <script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script> <script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script> <footer class="bd-footer"> <div class="bd-footer__inner bd-page-width"> <div class="footer-items__start"> <div class="footer-item"> <p class="copyright"> 漏 Copyright 2019, PyData Community. <br/> </p> </div> </div> <div class="footer-items__center"> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. <br/> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"> <p class="theme-version">  Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1. </p></div> </div> </div> </footer> </body> </html>

CINXE.COM

The PyData Sphinx Theme — PyData Theme 0.16.1 documentation