deploy: 8def179

_modules/index.html

@@ -862,7 +862,7 @@ <h1>All modules for which code is available</h1>
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/sphinx_immaterial/apidoc/cpp/api_parser.html

@@ -3509,7 +3509,7 @@ <h1>Source code for sphinx_immaterial.apidoc.cpp.api_parser</h1><div class="high
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/sphinx_immaterial/apidoc/cpp/apigen.html

@@ -1820,7 +1820,7 @@ <h1>Source code for sphinx_immaterial.apidoc.cpp.apigen</h1><div class="highligh
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/sphinx_immaterial/apidoc/cpp/external_cpp_references.html

@@ -1011,7 +1011,7 @@ <h1>Source code for sphinx_immaterial.apidoc.cpp.external_cpp_references</h1><di
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/sphinx_immaterial/apidoc/format_signatures.html

@@ -1703,7 +1703,7 @@ <h1>Source code for sphinx_immaterial.apidoc.format_signatures</h1><div class="h
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/sphinx_immaterial/custom_admonitions.html

@@ -1390,7 +1390,7 @@ <h1>Source code for sphinx_immaterial.custom_admonitions</h1><div class="highlig
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/tensorstore_demo.html

@@ -2211,7 +2211,7 @@ <h1>Source code for tensorstore_demo</h1><div class="highlight"><pre>
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/tensorstore_demo/_tensorstore.html

@@ -932,7 +932,7 @@ <h1>Source code for tensorstore_demo._tensorstore</h1><div class="highlight"><pr
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/test_py_module/test.html

@@ -1004,7 +1004,7 @@ <h1>Source code for test_py_module.test</h1><div class="highlight"><pre>
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_modules/type_param_demo.html

@@ -1021,7 +1021,7 @@ <h1>Source code for type_param_demo</h1><div class="highlight"><pre>
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

_sources/customization.rst.txt

@@ -298,6 +298,11 @@ Configuration Options
             Note that if the ``toc.integrate`` feature is enabled, the left
             sidebar is instead scrolled for the local table-of-contents as
             described above.
+
+          .. warning::
+             When enabling the ``toc.follow`` feature,
+             a `palette` must be set to avoid some known undesirable behavior.
+             See `issue 380 <https://github.com/jbms/sphinx-immaterial/issues/380>`_.
         - ``toc.sticky``
 
           Makes headings in the left and right sidebars "sticky", such that the

additional_samples.html

@@ -1963,7 +1963,7 @@ <h2 id="math">Math<a class="headerlink" href="#math" title="Link to this heading
 \end{eqnarray}</div></div>
 </div>
 <h2 id="production-lists">Production Lists<a class="headerlink" href="#production-lists" title="Link to this heading">¶</a></h2>
-<p>The following <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-productionlist" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">productionlist</span></code></a> is a modified example taken from
+<p>The following <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-productionlist" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">productionlist</span></code></a> is a modified example taken from
 <a class="reference external" href="https://graphviz.org/doc/info/lang.html">the Graphviz documentation</a></p>
 <div class="results docutils container">
 <div class="literal-block-wrapper docutils container" id="id11">
@@ -2040,7 +2040,7 @@ <h2 id="sub-pages">Sub-pages<a class="headerlink" href="#sub-pages" title="Link
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

admonitions.html

@@ -1496,7 +1496,7 @@ <h2 id="rst-and-sphinx"><span id="predefined-admonitions"></span>rST and Sphinx<
 <div class="seealso admonition">
 <p class="admonition-title">See also</p>
 <p>This admonition is specific to Sphinx directives and not defined in the reStructuredText
-specifications as you can <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-seealso" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">seealso</span></code></a>. The <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#directive-todo" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">todo</span></code></a> admonition is also defined as an extension
+specifications as you can <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-seealso" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">seealso</span></code></a>. The <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#directive-todo" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">todo</span></code></a> admonition is also defined as an extension
 that is distributed with Sphinx.</p>
 <p>The <a class="extlink-dutree reference external" href="https://docutils.sourceforge.io/docs/ref/doctree.html#note">note</a> admonition <em>is</em> defined by the reStructuredText specifications.</p>
 </div>
@@ -1551,7 +1551,7 @@ <h2 id="rst-and-sphinx"><span id="predefined-admonitions"></span>rST and Sphinx<
 </div>
 </div>
 <h2 id="version-directives">Version Directives<a class="headerlink" href="#version-directives" title="Link to this heading">¶</a></h2>
-<p>The <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">versionadded</span></code></a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">versionchanged</span></code></a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">deprecated</span></code></a>, and <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionremoved" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">versionremoved</span></code></a> directives defined by Sphinx are also
+<p>The <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">versionadded</span></code></a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">versionchanged</span></code></a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">deprecated</span></code></a>, and <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionremoved" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">versionremoved</span></code></a> directives defined by Sphinx are also
 rendered by the sphinx-immaterial theme as admonitions. The directives are optionally
 overridden to support additional <a class="reference internal" href="#directive-admonition" title="admonition directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">admonition</span></code></a> options <code class="code highlight rst docutils literal highlight-rst"><span class="nc">:collapsible:</span></code>,
 <code class="code highlight rst docutils literal highlight-rst"><span class="nc">:name:</span></code>, and <code class="code highlight rst docutils literal highlight-rst"><span class="nc">:class:</span></code>.</p>
@@ -1589,7 +1589,7 @@ <h2 id="version-directives">Version Directives<a class="headerlink" href="#versi
 all other options are ignored.</p>
 <div class="literal-block-wrapper docutils container" id="id8">
 <div class="code-block-caption highlight"><span class="filename"><span class="caption-text">
-</span>Adjusting the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">versionchanged</span></code></a> style<a class="headerlink" href="#id8" title="Permalink to this code">¶</a></span></div>
+</span>Adjusting the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">versionchanged</span></code></a> style<a class="headerlink" href="#id8" title="Permalink to this code">¶</a></span></div>
 <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><code><span class="n">sphinx_immaterial_custom_admonitions</span> <span class="o">=</span> <span class="p">[</span>
     <span class="p">{</span>
         <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;versionchanged&quot;</span><span class="p">,</span>
@@ -2116,7 +2116,7 @@ <h2 id="admonition-directive">Admonition Directive<a class="headerlink" href="#a
 <dt class="sig sig-object highlight rst" id="directive-option-admonition-name">
 <span class="sig-name descname"><span class="pre">:name:</span></span><a class="headerlink" href="#directive-option-admonition-name" title="Link to this definition">¶</a></dt>
 <dd><p>Set this option with a qualified ID to reference the admonition from
-other parts of the documentation using the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">ref</span></code></a> role.</p>
+other parts of the documentation using the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">ref</span></code></a> role.</p>
 <div class="results docutils container">
 <div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><code><span class="p">..</span> <span class="ow">quote</span><span class="p">::</span> Referencing an Admonition
    <span class="nc">:name:</span> my-admonition
@@ -2416,7 +2416,7 @@ <h4 id="changing-the-admonition-icon"><span id="change-admonition-icon"></span>C
 This will only work with <a class="reference external" href="https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons">any of the icons bundled with this theme</a>.</p>
 <div class="literal-block-wrapper docutils container" id="id19">
 <div class="code-block-caption highlight"><span class="filename"><span class="caption-text">
-</span>Changing the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-note" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">note</span></code></a> icon in conf.py<a class="headerlink" href="#id19" title="Permalink to this code">¶</a></span></div>
+</span>Changing the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-note" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">note</span></code></a> icon in conf.py<a class="headerlink" href="#id19" title="Permalink to this code">¶</a></span></div>
 <div class="highlight-python notranslate"><div class="annotate highlight"><pre><span></span><code><span class="n">html_theme_options</span> <span class="o">=</span> <span class="p">{</span>
     <span class="s2">&quot;icon&quot;</span><span class="p">:</span> <span class="p">{</span>
         <span class="s2">&quot;admonition&quot;</span><span class="p">:</span> <span class="p">{</span>
@@ -2505,7 +2505,7 @@ <h5 id="id1">Equivalent approach with <a class="reference internal" href="#custo
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

apidoc/cpp/apigen.html

@@ -1803,7 +1803,7 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
 <span class="sig-name descname"><span class="pre">cpp_apigen_rst_prolog</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><span class="p"> <span class="pre">=</span> </span><code class="python code highlight docutils literal highlight-python"><span class="s1">&#39;&#39;</span></code><a class="headerlink" href="#confval-cpp_apigen_rst_prolog" title="Link to this definition">¶</a></dt>
 <dd><p>A string of reStructuredText that will be included at the beginning of the
 documentation text for each entity.</p>
-<p>This may be used to set the <a class="extlink-dudir reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#default-role">rST directive default-role</a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-highlight" title="(in Sphinx v8.2.1)"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">highlight</span></code></a>
+<p>This may be used to set the <a class="extlink-dudir reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#default-role">rST directive default-role</a>, <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-highlight" title="(in Sphinx v8.3.0)"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">highlight</span></code></a>
 language, or <a class="reference internal" href="../../code_syntax_highlighting.html#directive-default-literal-role" title="default-literal-role directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">default-literal-role</span></code></a>.</p>
 <div class="note admonition">
 <p class="admonition-title">Note</p>
@@ -1852,7 +1852,7 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

apidoc/cpp/cppreference.html

@@ -988,7 +988,7 @@ <h1 id="automatic-cross-linking-to-cppreference-com">Automatic cross-linking to
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>

apidoc/cpp/external_cpp_references.html

@@ -1006,9 +1006,9 @@
 <h1 id="external-c-symbol-links">External C++ symbol links<a class="headerlink" href="#external-c-symbol-links" title="Link to this heading">¶</a></h1>
 <p>This theme includes an optional
 <code class="code highlight python docutils literal highlight-python"><span class="n">sphinx_immaterial</span><span class="o">.</span><span class="n">apidoc</span><span class="o">.</span><span class="n">cpp</span><span class="o">.</span><span class="n">external_cpp_references</span></code> extension that
-allows normal C++ symbol references, e.g. through the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/domains/cpp.html#role-cpp-expr" title="(in Sphinx v8.2.1)"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">cpp:expr</span></code></a> role
+allows normal C++ symbol references, e.g. through the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/domains/cpp.html#role-cpp-expr" title="(in Sphinx v8.3.0)"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">cpp:expr</span></code></a> role
 or in C++ function signatures, to resolve to externally-defined C++ symbols that
-are manually specified in <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>.  Unlike the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="(in Sphinx v8.2.1)"><code class="xref any docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a>
+are manually specified in <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>.  Unlike the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="(in Sphinx v8.3.0)"><code class="xref any docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a>
 extension, template arguments are stripped when resolving references, which
 allows template entities to be resolved based on their base name.</p>
 <p>To use this extension, add it to the list of extensions in <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code> and
@@ -1106,7 +1106,7 @@ <h1 id="external-c-symbol-links">External C++ symbol links<a class="headerlink"
   <small>
 
       Last update:
-      Feb 23, 2025
+      Feb 25, 2025
 
   </small>
 </div>