CINXE.COM
Configuration — Read the Docs Sphinx Theme 3.0.2 documentation
<!doctype html> <html class="writer-html5" lang="en"> <head> <base href="https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html"> <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>Configuration — 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="Development" href="development.html"> <link rel="prev" 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="/configuring.html"> <meta name="readthedocs-http-status" content="200"> <meta http-equiv="X-Translated-By" content="Google"> <meta http-equiv="X-Translated-To" content="iw"> <script type="text/javascript" src="https://www.gstatic.com/_/translate_http/_/js/k=translate_http.tr.en_GB.1hbgkFx4Qn8.O/am=DgY/d=1/rs=AN8SPfqlmAPxwfG457BPbRXwNq39oSMGHg/m=corsproxy" data-sourceurl="https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html"></script> <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200" rel="stylesheet"> <script type="text/javascript" src="https://www.gstatic.com/_/translate_http/_/js/k=translate_http.tr.en_GB.1hbgkFx4Qn8.O/am=DgY/d=1/exm=corsproxy/ed=1/rs=AN8SPfqlmAPxwfG457BPbRXwNq39oSMGHg/m=phishing_protection" data-phishing-protection-enabled="false" data-forms-warning-enabled="true" data-source-url="https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html"></script> <meta name="robots" content="none"> </head> <body class="wy-body-for-nav"> <script type="text/javascript" src="https://www.gstatic.com/_/translate_http/_/js/k=translate_http.tr.en_GB.1hbgkFx4Qn8.O/am=DgY/d=1/exm=corsproxy,phishing_protection/ed=1/rs=AN8SPfqlmAPxwfG457BPbRXwNq39oSMGHg/m=navigationui" data-environment="prod" data-proxy-url="https://sphinx--rtd--theme-readthedocs-io.translate.goog" data-proxy-full-url="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB" data-source-url="https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html" data-source-language="pl" data-target-language="iw" data-display-language="en-GB" data-detected-source-language="" data-is-source-untranslated="false" data-source-untranslated-url="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html&anno=2" data-client="tr"></script> <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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/index.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB"> <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 class="current"> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/installing.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">Installation</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#">Configuration</a> <ul> <li class="toctree-l2"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#theme-options">Theme options</a> <ul> <li class="toctree-l3"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#table-of-contents-options">Table of contents options</a></li> <li class="toctree-l3"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#miscellaneous-options">Miscellaneous options</a></li> </ul></li> <li class="toctree-l2"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#file-wide-metadata">File-wide metadata</a></li> <li class="toctree-l2"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#other-configuration">Other configuration</a> <ul> <li class="toctree-l3"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#adding-a-logo">Adding a logo</a></li> <li class="toctree-l3"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#adding-custom-css-or-javascript">Adding custom CSS or Javascript</a></li> </ul></li> <li class="toctree-l2"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#how-the-table-of-contents-displays">How the table of contents displays</a></li> </ul></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/development.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">Development</a></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/contributing.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">Contributing</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/changelog.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/structure.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">1. Structural Elements</a></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/structure.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#structural-elements-2">2. Structural Elements 2</a></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/demo.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">3. Paragraph Level Markup</a></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/lists_tables.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">4. Lists & Tables</a></li> <li class="toctree-l1"><a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/api.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/long.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/demo/level1/index.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/index.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB">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="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/index.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Configuration</li> <li class="wy-breadcrumbs-aside"><a href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/_sources/configuring.rst.txt?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB" rel="nofollow"> View page source</a></li> </ul> <hr> </div> <div role="main" class="document" itemscope itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="configuration"> <h1>Configuration<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#configuration" title="Permalink to this heading"></a></h1> <section id="theme-options"> <h2>Theme options<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#theme-options" title="Permalink to this heading"></a></h2> <p>The following options can be defined in your project’s <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file, using the <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/configuration.html%23confval-html_theme_options" title="(in Sphinx v8.2.0)"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_theme_options</span></code></a> configuration option.</p> <p>For example:</p> <div class="highlight-python notranslate"> <div class="highlight"> <pre><span></span><span class="n">html_theme_options</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'analytics_id'</span><span class="p">:</span> <span class="s1">'G-XXXXXXXXXX'</span><span class="p">,</span> <span class="c1"># Provided by Google in your dashboard</span> <span class="s1">'analytics_anonymize_ip'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'logo_only'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'prev_next_buttons_location'</span><span class="p">:</span> <span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'style_external_links'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'vcs_pageview_mode'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> <span class="s1">'style_nav_header_background'</span><span class="p">:</span> <span class="s1">'white'</span><span class="p">,</span> <span class="s1">'flyout_display'</span><span class="p">:</span> <span class="s1">'hidden'</span><span class="p">,</span> <span class="s1">'version_selector'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'language_selector'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="c1"># Toc options</span> <span class="s1">'collapse_navigation'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'sticky_navigation'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'navigation_depth'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s1">'includehidden'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'titles_only'</span><span class="p">:</span> <span class="kc">False</span> <span class="p">}</span> </pre> </div> </div> <section id="table-of-contents-options"> <h3>Table of contents options<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#table-of-contents-options" title="Permalink to this heading"></a></h3> <p>The following options change how <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html%23directive-toctree" title="(in Sphinx v8.2.0)"><code class="docutils literal notranslate"><span class="pre">toctree</span></code></a> directives generate documentation navigation.</p> <dl class="std confval"> <dt class="sig sig-object std" id="confval-collapse_navigation"><span class="sig-name descname"><span class="pre">collapse_navigation</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-collapse_navigation" title="Permalink to this definition"></a> </dt> <dd> <p>With this enabled, navigation entries are not expandable – the <code class="docutils literal notranslate"><span class="pre">[+]</span></code> icons next to each entry are removed.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">True</span></code></p> </dd> </dl> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Setting <a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-collapse_navigation"><code class="xref std std-confval docutils literal notranslate"><span class="pre">collapse_navigation</span></code></a> to <code class="docutils literal notranslate"><span class="pre">False</span></code> and using a high value for <a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-navigation_depth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">navigation_depth</span></code></a> on projects with many files and a deep file structure can cause long compilation times and can result in HTML files that are significantly larger in file size.</p> </div> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-sticky_navigation"><span class="sig-name descname"><span class="pre">sticky_navigation</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-sticky_navigation" title="Permalink to this definition"></a> </dt> <dd> <p>Scroll the navigation with the main page content as you scroll the page.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">True</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-navigation_depth"><span class="sig-name descname"><span class="pre">navigation_depth</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-navigation_depth" title="Permalink to this definition"></a> </dt> <dd> <p>The maximum depth of the table of contents tree. Set this to <code class="docutils literal notranslate"><span class="pre">-1</span></code> to allow unlimited depth.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>integer</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">4</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-includehidden"><span class="sig-name descname"><span class="pre">includehidden</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-includehidden" title="Permalink to this definition"></a> </dt> <dd> <p>Specifies if the navigation includes hidden table(s) of contents – that is, any <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html%23directive-toctree" title="(in Sphinx v8.2.0)"><code class="docutils literal notranslate"><span class="pre">toctree</span></code></a> directive that is marked with the <code class="docutils literal notranslate"><span class="pre">:hidden:</span></code> option.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">True</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-titles_only"><span class="sig-name descname"><span class="pre">titles_only</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-titles_only" title="Permalink to this definition"></a> </dt> <dd> <p>When enabled, page subheadings are not included in the navigation.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p>False</p> </dd> </dl> </dd> </dl> </section> <section id="miscellaneous-options"> <h3>Miscellaneous options<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#miscellaneous-options" title="Permalink to this heading"></a></h3> <dl class="std confval"> <dt class="sig sig-object std" id="confval-analytics_id"><span class="sig-name descname"><span class="pre">analytics_id</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-analytics_id" title="Permalink to this definition"></a> </dt> <dd> <p>If specified, Google Analytics’ <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://developers.google.com/gtagjs">gtag.js</a> is included in your pages. Set the value to the ID provided to you by google (like <code class="docutils literal notranslate"><span class="pre">UA-XXXXXXX</span></code> or <code class="docutils literal notranslate"><span class="pre">G-XXXXXXXXXX</span></code>).</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>string</p> </dd> </dl> <div class="deprecated"> <p><span class="versionmodified deprecated">Deprecated since version 3.0.0: </span>The <code class="docutils literal notranslate"><span class="pre">analytics_id</span></code> option is deprecated, use the <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://pypi.org/project/sphinxcontrib-googleanalytics/">sphinxcontrib-googleanalytics</a> extension instead.</p> </div> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-analytics_anonymize_ip"><span class="sig-name descname"><span class="pre">analytics_anonymize_ip</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-analytics_anonymize_ip" title="Permalink to this definition"></a> </dt> <dd> <blockquote> <div> <p>Anonymize visitor IP addresses in Google Analytics.</p> </div> </blockquote> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">False</span></code></p> </dd> </dl> <div class="deprecated"> <p><span class="versionmodified deprecated">Deprecated since version 3.0.0: </span>The <code class="docutils literal notranslate"><span class="pre">analytics_anonymize_ip</span></code> option is deprecated, use the <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://pypi.org/project/sphinxcontrib-googleanalytics/">sphinxcontrib-googleanalytics</a> extension instead.</p> </div> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-canonical_url"><span class="sig-name descname"><span class="pre">canonical_url</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-canonical_url" title="Permalink to this definition"></a> </dt> <dd> <p>This will specify a <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://en.wikipedia.org/wiki/Canonical_link_element">canonical URL</a> meta link element to tell search engines which URL should be ranked as the primary URL for your documentation. This is important if you have multiple URLs that your documentation is available through. The URL points to the root path of the documentation and requires a trailing slash.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>URL</p> </dd> </dl> <div class="deprecated"> <p><span class="versionmodified deprecated">Deprecated since version 0.6.0: </span>Use <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/configuration.html%23confval-html_baseurl" title="(in Sphinx v8.2.0)"><code class="docutils literal notranslate"><span class="pre">html_baseurl</span></code></a> instead.</p> </div> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-display_version"><span class="sig-name descname"><span class="pre">display_version</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-display_version" title="Permalink to this definition"></a> </dt> <dd> <p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, the version number is shown at the top of the sidebar.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">False</span></code></p> </dd> </dl> <div class="deprecated"> <p><span class="versionmodified deprecated">Deprecated since version 3.0.0: </span>Removed in favor of <code class="docutils literal notranslate"><span class="pre">version_selector</span></code> and <code class="docutils literal notranslate"><span class="pre">language_selector</span></code>.</p> </div> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-logo_only"><span class="sig-name descname"><span class="pre">logo_only</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-logo_only" title="Permalink to this definition"></a> </dt> <dd> <p>Only display the logo image, do not display the project name at the top of the sidebar</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">False</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-prev_next_buttons_location"><span class="sig-name descname"><span class="pre">prev_next_buttons_location</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-prev_next_buttons_location" title="Permalink to this definition"></a> </dt> <dd> <p>Location to display <span class="guilabel">Next</span> and <span class="guilabel">Previous</span> buttons. This can be either <code class="docutils literal notranslate"><span class="pre">bottom</span></code>, <code class="docutils literal notranslate"><span class="pre">top</span></code>, <code class="docutils literal notranslate"><span class="pre">both</span></code> , or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>string</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">bottom</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-style_external_links"><span class="sig-name descname"><span class="pre">style_external_links</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-style_external_links" title="Permalink to this definition"></a> </dt> <dd> <p>Add an icon next to external links.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">False</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-vcs_pageview_mode"><span class="sig-name descname"><span class="pre">vcs_pageview_mode</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-vcs_pageview_mode" title="Permalink to this definition"></a> </dt> <dd> <p>Changes how to view files when using <code class="docutils literal notranslate"><span class="pre">display_github</span></code>, <code class="docutils literal notranslate"><span class="pre">display_gitlab</span></code>, etc. When using GitHub or GitLab this can be: <code class="docutils literal notranslate"><span class="pre">blob</span></code> (default), <code class="docutils literal notranslate"><span class="pre">edit</span></code>, or <code class="docutils literal notranslate"><span class="pre">raw</span></code>. On Bitbucket, this can be either: <code class="docutils literal notranslate"><span class="pre">view</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">edit</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>string</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">blob</span></code> or <code class="docutils literal notranslate"><span class="pre">view</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-style_nav_header_background"><span class="sig-name descname"><span class="pre">style_nav_header_background</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-style_nav_header_background" title="Permalink to this definition"></a> </dt> <dd> <p>Changes the background of the search area in the navigation bar. The value can be anything valid in a CSS <cite>background</cite> property.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>string</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">#2980B9</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-flyout_display"><span class="sig-name descname"><span class="pre">flyout_display</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-flyout_display" title="Permalink to this definition"></a> </dt> <dd> <p>Specify how to display the flyout (language and version selector). This can be either <code class="docutils literal notranslate"><span class="pre">attached</span></code> or <code class="docutils literal notranslate"><span class="pre">hidden</span></code>. <code class="docutils literal notranslate"><span class="pre">attached</span></code> means that it will show the flyout in the bottom of the sidebar. You will need to disable the default <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://docs.readthedocs.io/en/stable/flyout-menu.html">Read the Docs flyout</a> in order to not have 2 flyouts showing.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>str</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">hidden</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-version_selector"><span class="sig-name descname"><span class="pre">version_selector</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-version_selector" title="Permalink to this definition"></a> </dt> <dd> <p>Display a version selector below the title. This feature makes usage of <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://docs.readthedocs.io/page/addons.html">Read the Docs Addons</a> for this, so it’s required the documentation to be hosted on Read the Docs. It only appears when there are more than 1 active version.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">True</span></code></p> </dd> </dl> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-language_selector"><span class="sig-name descname"><span class="pre">language_selector</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-language_selector" title="Permalink to this definition"></a> </dt> <dd> <p>Display a language selector below the title. This feature makes usage of <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://docs.readthedocs.io/page/addons.html">Read the Docs Addons</a> for this, so it’s required the documentation to be served on Read the Docs. It only appears when there is more than 1 active language.</p> <dl class="field-list simple"> <dt class="field-odd"> Type<span class="colon">:</span> </dt> <dd class="field-odd"> <p>boolean</p> </dd> <dt class="field-even"> Default<span class="colon">:</span> </dt> <dd class="field-even"> <p><code class="docutils literal notranslate"><span class="pre">True</span></code></p> </dd> </dl> </dd> </dl> </section> </section> <section id="file-wide-metadata"> <h2>File-wide metadata<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#file-wide-metadata" title="Permalink to this heading"></a></h2> <p>The following options can be used as <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html%23metadata" title="(in Sphinx v8.2.0)"><span class="xref std std-ref">file-wide metadata</span></a>:</p> <dl class="std confval"> <dt class="sig sig-object std" id="confval-github_url"><span class="sig-name descname"><span class="pre">github_url</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-github_url" title="Permalink to this definition"></a> </dt> <dd> <p>Force the <span class="guilabel">Edit on GitHub</span> button to use the configured URL.</p> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-bitbucket_url"><span class="sig-name descname"><span class="pre">bitbucket_url</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-bitbucket_url" title="Permalink to this definition"></a> </dt> <dd> <p>Force the <span class="guilabel">Edit on Bitbucket</span> button to use the configured URL.</p> </dd> </dl> <dl class="std confval"> <dt class="sig sig-object std" id="confval-gitlab_url"><span class="sig-name descname"><span class="pre">gitlab_url</span></span><a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-gitlab_url" title="Permalink to this definition"></a> </dt> <dd> <p>Force the <span class="guilabel">Edit on GitLab</span> button to use the configured URL.</p> </dd> </dl> </section> <section id="other-configuration"> <h2>Other configuration<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#other-configuration" title="Permalink to this heading"></a></h2> <section id="adding-a-logo"> <h3>Adding a logo<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#adding-a-logo" title="Permalink to this heading"></a></h3> <p>Using the Sphinx standard option <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/configuration.html%23confval-html_logo" title="(in Sphinx v8.2.0)"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_logo</span></code></a>, you can set an image file to be used as a logo at the top of the sidebar. The theme option <a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-logo_only"><code class="xref std std-confval docutils literal notranslate"><span class="pre">logo_only</span></code></a> also allows for <em>only</em> the logo to be shown at the top of the sidebar.</p> </section> <section id="adding-custom-css-or-javascript"> <h3>Adding custom CSS or Javascript<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#adding-custom-css-or-javascript" title="Permalink to this heading"></a></h3> <p>Adding custom CSS or Javascript can help you alter the look and feel of this theme without forking the theme for local use.</p> <p>In order to add custom CSS or Javascript without disrupting the existing theme files, you can <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html" title="(in Read the Docs user documentation v11.13.0)"><span class="xref std std-doc">add files to be included in your documentation output</span></a>.</p> </section> </section> <section id="how-the-table-of-contents-displays"> <h2>How the table of contents displays<a class="headerlink" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#how-the-table-of-contents-displays" title="Permalink to this heading"></a></h2> <p>Currently the left menu will build based upon any <code class="docutils literal notranslate"><span class="pre">toctree</span></code> directives defined in your source files. It outputs 4 levels of depth by default, to allow for quick navigation through topics. If no TOC trees are defined, Sphinx’s default behavior is to use the page headings instead.</p> <p>It’s important to note that if you don’t follow the same styling for your reST headings across your documents, the TOC tree will build incorrectly, and the resulting menu might not show the correct depth when it renders.</p> <p>Also note that by default the table of contents is set with <code class="docutils literal notranslate"><span class="pre">includehidden=True</span></code>. This allows you to set a hidden TOC in your index file with the <a class="reference external" href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html%23toctree-directive" title="(in Sphinx v8.2.0)"><span class="xref std std-ref">:hidden:</span></a> property that will allow you to build a TOC without it rendering in your index.</p> <p>By default, the navigation will “stick” to the screen as you scroll. However if your TOC is not tall enough, it will revert to static positioning. To disable the sticky navigation altogether, change the <a class="reference internal" href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/configuring.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB#confval-sticky_navigation"><code class="xref std std-confval docutils literal notranslate"><span class="pre">sticky_navigation</span></code></a> theme option.</p> </section> </section> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="Footer"><a href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/installing.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="https://sphinx--rtd--theme-readthedocs-io.translate.goog/en/stable/development.html?_x_tr_sl=pl&_x_tr_tl=iw&_x_tr_hl=en-GB" class="btn btn-neutral float-right" title="Development" 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://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://translate.google.com/website?sl=pl&tl=iw&hl=en-GB&u=https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> <script>function gtElInit() {var lib = new google.translate.TranslateService();lib.translatePage('pl', 'iw', function () {});}</script> <script src="https://translate.google.com/translate_a/element.js?cb=gtElInit&hl=en-GB&client=wt" type="text/javascript"></script> </body> </html>