{% set permalink = ("Link" if sphinx_version >= (7, 2) else 'Permalink') -%}
{% set heading = ("heading" if sphinx_version >= (5, 0) else 'headline') -%}
{% set sig_prename_tag=("span" if sphinx_version >= (4, 0) else 'code') -%}
{% set sig_object_class_std=(' class="sig sig-object std"' if sphinx_version >= (4, 0) else '') -%}
{% set sig_object_class_py=(' class="sig sig-object py"' if sphinx_version >= (4, 0) else '') -%}
<!DOCTYPE html>
<html{% if sphinx_version >= (7, 2) %} data-content_root="./"{% endif %}{% if sphinx_version >= (5, 0) %} lang="en"{% endif %}>
 <head>
  <meta charset="utf-8"/>
  <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
  {% if docutils_version[1] == 18 %}<meta content="Docutils 0.18.1: http://docutils.sourceforge.net/" name="generator"/>
  {% elif docutils_version[1] == 17 %}<meta content="Docutils 0.17.1: http://docutils.sourceforge.net/" name="generator"/>
  {% elif docutils_version[1] == 19 %}<meta content="Docutils 0.19: https://docutils.sourceforge.io/" name="generator"/>
  {% elif docutils_version[1] >= 20 %}<meta content="width=device-width, initial-scale=1" name="viewport"/>
  {% endif %}<title>
   sphinx-toolbox Demo - :sourcelink: — Python  documentation
  </title>{% if sphinx_version >= (7, 2) %}
  <script src="_static/documentation_options.js?v=5929fcd5">{% else %}
  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js{% if sphinx_version >= (7, 1) %}?v=b3ba4146{% endif %}">{% endif %}
  </script>{% if sphinx_version < (6, 0) %}
  <script src="_static/jquery.js">
  </script>
  <script src="_static/underscore.js">
  </script>{% if sphinx_version >= (5, 0) %}
  <script src="_static/_sphinx_javascript_frameworks_compat.js">
  </script>{% endif %}{% endif %}
  <script src="_static/doctools.js{% if sphinx_version >= (8, 1) %}?v=9bcbadda{% elif sphinx_version >= (7, 3) %}?v=9a2dae69{% elif sphinx_version >= (7, 1) %}?v=888ff710{% endif %}">
  </script>{% if sphinx_version >= (5, 2) %}
  <script src="_static/sphinx_highlight.js{% if sphinx_version >= (7, 2) %}?v=dc90522c{% elif sphinx_version >= (7, 1) %}?v=4825356b{% endif %}">
  </script>{% endif %}
  <script src="_static/sphinx_toolbox_installation.js">
  </script>
 </head>
 <body>
  <div class="document">
   <div class="documentwrapper">
    <div class="bodywrapper">
     <div class="body" role="main">
      <div class="section" id="sphinx-toolbox-demo-sourcelink">
       <h1>
        sphinx-toolbox Demo - :sourcelink:
        <a class="headerlink" href="#sphinx-toolbox-demo-sourcelink" title="{{ permalink }} to this {{ heading }}">
         ¶
        </a>
       </h1>
       <p class="source-link">
        <strong>
         Source code:
        </strong>
        <a class="reference external" href="https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/autotypeddict_demo.py">
         autotypeddict_demo.py
        </a>
       </p>
       <hr class="docutils"/>
       <p>
        Demo of
        <code class="docutils literal notranslate">
         <span class="pre">
          ..
         </span>
         <span class="pre">
          autotypeddict::
         </span>
        </code>
       </p>
       <dl class="py class typeddict">
        <dt{{ sig_object_class_py }}>
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Animal
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Animal">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
        </dt>
        <dd>
         <p>
          Optional keys common to all animals.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class_py }}>
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Bird
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Bird">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
        </dt>
        <dd>
         <p>
          A bird.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               egg_size
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 float
                </span>
               </code>
              </a>
              ) – The size of the bird’s egg, in mm.
             </p>
            </li>
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class_py }}>
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Cat
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Cat">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
        </dt>
        <dd>
         <p>
          A cat.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               fur_color
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The colour of the cat’s fur.
             </p>
            </li>
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
           </ul>
          </dd>
          <dt class="field-even">
           Optional Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-even">
           <ul class="simple">
            <li>
             <p>
              <strong>
               voice
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The animal’s voice.
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>
       <dl class="py class typeddict">
        <dt{{ sig_object_class_py }}>
         <em class="property">
          typeddict
         </em>
         <{{ sig_prename_tag }} class="sig-prename descclassname">
          autotypeddict_demo.
         </{{ sig_prename_tag }}>
         <{{ sig_prename_tag }} class="sig-name descname">
          Movie
         </{{ sig_prename_tag }}>
         <a class="reference internal" href="_modules/autotypeddict_demo.html#Movie">
          <span class="viewcode-link">
           [source]
          </span>
         </a>
        </dt>
        <dd>
         <p>
          Represents a movie.
         </p>
         <dl class="field-list simple">
          <dt class="field-odd">
           Required Keys{% if docutils_version >= (0, 18) %}
           <span class="colon">
            :
           </span>{% endif %}
          </dt>
          <dd class="field-odd">
           <ul class="simple">
            <li>
             <p>
              <strong>
               name
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              ) – The name of the animal
             </p>
            </li>
            <li>
             <p>
              <strong>
               year
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 int
                </span>
               </code>
              </a>
              ) – The movie’s release year.
             </p>
            </li>
            <li>
             <p>
              <strong>
               based_on
              </strong>
              (
              <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
               <code class="xref py py-class docutils literal notranslate">
                <span class="pre">
                 str
                </span>
               </code>
              </a>
              )
             </p>
            </li>
           </ul>
          </dd>
         </dl>
        </dd>
       </dl>{% if sphinx_version >= (7, 2) %}
       <p class="source-link" id="module-sphinx_toolbox.more_autosummary">{% else %}
       <span class="target" id="module-sphinx_toolbox.more_autosummary">
       </span>
       <p class="source-link">{% endif %}
        <strong>
         Source code:
        </strong>
        <a class="reference external" href="https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/sphinx_toolbox/more_autosummary/__init__.py">
         sphinx_toolbox/more_autosummary/__init__.py
        </a>
       </p>
       <hr class="docutils"/>
       <p>
        Extensions to
        <code class="xref py py-mod docutils literal notranslate">
         <span class="pre">
          sphinx.ext.autosummary
         </span>
        </code>
        .
       </p>
       <p>
        Provides an enhanced version of
        <a class="reference external" href="https://autodocsumm.readthedocs.io/">
         https://autodocsumm.readthedocs.io/
        </a>
        which respects the autodoc
        <code class="docutils literal notranslate">
         <span class="pre">
          member-order
         </span>
        </code>
        option.
This can be given for an individual directive, in the
        <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_member_order">
         autodoc_member_order
        </a>
        configuration value, or via
        <a class="reference internal" href="#confval-autodocsumm_member_order">
         <code class="xref std std-confval docutils literal notranslate">
          <span class="pre">
           autodocsumm_member_order
          </span>
         </code>
        </a>
        .
       </p>
       <p>
        Also patches
        <code class="xref py py-class docutils literal notranslate">
         <span class="pre">
          sphinx.ext.autosummary.Autosummary
         </span>
        </code>
        to fix an issue where
the module name is sometimes duplicated.
I.e.
        <code class="docutils literal notranslate">
         <span class="pre">
          foo.bar.baz()
         </span>
        </code>
        became
        <code class="docutils literal notranslate">
         <span class="pre">
          foo.bar.foo.bar.baz()
         </span>
        </code>
        , which of course doesn’t exist
and created a broken link.
       </p>
       <div class="versionadded">
        <p>
         <span class="versionmodified added">
          {% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 0.7.0.
         </span>
        </p>
       </div>
       <div class="versionchanged">
        <p>
         <span class="versionmodified changed">
          Changed in version 1.3.0:
         </span>
         Autosummary now selects the appropriate documenter for attributes rather than
falling back to
         <code class="xref py py-class docutils literal notranslate">
          <span class="pre">
           DataDocumenter
          </span>
         </code>
         .
        </p>
       </div>
       <div class="versionchanged">
        <p>
         <span class="versionmodified changed">
          Changed in version 2.13.0:
         </span>
         Also patches
         <code class="xref py py-class docutils literal notranslate">
          <span class="pre">
           sphinx.ext.autodoc.ModuleDocumenter
          </span>
         </code>
         to fix an issue where
         <code class="docutils literal notranslate">
          <span class="pre">
           __all__
          </span>
         </code>
         is not respected for autosummary tables.
        </p>
       </div>
       <div class="section" id="configuration">
        <h2>
         Configuration
         <a class="headerlink" href="#configuration" title="{{ permalink }} to this {{ heading }}">
          ¶
         </a>
        </h2>
        <dl class="std confval">
         <dt{{ sig_object_class_std }} id="confval-autodocsumm_member_order">
          <{{ sig_prename_tag }} class="sig-name descname">
           autodocsumm_member_order
          </{{ sig_prename_tag }}>
          <a class="headerlink" href="#confval-autodocsumm_member_order" title="Permalink to this definition">
           ¶
          </a>
         </dt>
         <dd>
          <div class="line-block">
           <div class="line">
            <strong>
             Type:
            </strong>
            <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
             <code class="xref py py-obj docutils literal notranslate">
              <span class="pre">
               str
              </span>
             </code>
            </a>
           </div>
           <div class="line">
            <strong>
             Default:
            </strong>
            <code class="docutils literal notranslate">
             <span class="pre">
              'alphabetical'
             </span>
            </code>
           </div>
          </div>
          <p>
           Determines the sort order of members in
           <code class="docutils literal notranslate">
            <span class="pre">
             autodocsumm
            </span>
           </code>
           summary tables.
Valid values are
           <code class="docutils literal notranslate">
            <span class="pre">
             'alphabetical'
            </span>
           </code>
           and
           <code class="docutils literal notranslate">
            <span class="pre">
             'bysource'
            </span>
           </code>
           .
          </p>
          <p>
           Note that for
           <code class="docutils literal notranslate">
            <span class="pre">
             'bysource'
            </span>
           </code>
           the module must be a Python module with the source code available.
          </p>
          <p>
           The member order can also be set on a per-directive basis using the
           <code class="docutils literal notranslate">
            <span class="pre">
             :member-order:
            </span>
            <span class="pre">
             [order]
            </span>
           </code>
           option.
This applies not only to
           <code class="xref rst rst-dir docutils literal notranslate">
            <span class="pre">
             automodule
            </span>
           </code>
           etc. directives,
but also to
           <code class="xref rst rst-dir docutils literal notranslate">
            <span class="pre">
             automodulesumm
            </span>
           </code>
           etc. directives.
          </p>
         </dd>
        </dl>
        <dl class="std confval">
         <dt{{ sig_object_class_std }} id="confval-autosummary_col_type">
          <{{ sig_prename_tag }} class="sig-name descname">
           autosummary_col_type
          </{{ sig_prename_tag }}>
          <a class="headerlink" href="#confval-autosummary_col_type" title="Permalink to this definition">
           ¶
          </a>
         </dt>
         <dd>
          <div class="line-block">
           <div class="line">
            <strong>
             Type:
            </strong>
            <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">
             <code class="xref py py-obj docutils literal notranslate">
              <span class="pre">
               str
              </span>
             </code>
            </a>
           </div>
           <div class="line">
            <strong>
             Default:
            </strong>
            <code class="docutils literal notranslate">
             <span class="pre">
              '\X'
             </span>
            </code>
           </div>
          </div>
          <p>
           The LaTeX column type to use for autosummary tables.
          </p>
          <p>
           Custom columns can be defined in the LaTeX preamble for use with this option.
          </p>
          <p>
           For example:
          </p>
          <div class="highlight-python notranslate">
           <div class="highlight">
            <pre><span></span><span class="n">latex_elements</span><span class="p">[</span><span class="s2">"preamble"</span><span class="p">]</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">'''</span>
<span class="s1">    \makeatletter</span>
<span class="s1">    \newcolumntype{\Xx}[2]{&gt;{\raggedright\arraybackslash}p{\dimexpr</span>
<span class="s1">        (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}}</span>
<span class="s1">    \makeatother</span>
<span class="s1">    '''</span>

<span class="n">autosummary_col_type</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">Xx"</span>
</pre>
           </div>
          </div>
          <div class="versionadded">
           <p>
            <span class="versionmodified added">
             {% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 2.13.0.
            </span>
           </p>
          </div>
         </dd>
        </dl>
       </div>
       <div class="section" id="api-reference">
        <h2>
         API Reference
         <a class="headerlink" href="#api-reference" title="{{ permalink }} to this {{ heading }}">
          ¶
         </a>
        </h2>
       </div>
      </div>{% if sphinx_version >= (8, 1) %}
      <div class="clearer">
      </div>{% endif %}
     </div>
    </div>
   </div>
   <div class="clearer">
   </div>
  </div>
 </body>
</html>
