sphinx-toolbox Demo - :sourcelink: ¶
Source code: autotypeddict_demo.py
        Demo of
        
         
          ..
         
         
          autotypeddict::
         
        
       
- typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Animal {{ sig_prename_tag }}> [source]
- 
         Optional keys common to all animals. 
- typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Bird {{ sig_prename_tag }}> [source]
- 
         A bird. 
- typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Cat {{ sig_prename_tag }}> [source]
- 
         A cat. 
- typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> Movie {{ sig_prename_tag }}> [source]
- 
         Represents a movie. 
{% else %}
{% endif %} Source code: sphinx_toolbox/more_autosummary/__init__.py
        Extensions to
        
         
          sphinx.ext.autosummary
         
        
        .
       
        Provides an enhanced version of
        
         https://autodocsumm.readthedocs.io/
        
        which respects the autodoc
        
         
          member-order
         
        
        option.
This can be given for an individual directive, in the
        
         autodoc_member_order
        
        configuration value, or via
        
         
          
           autodocsumm_member_order
          
         
        
        .
       
        Also patches
        
         
          sphinx.ext.autosummary.Autosummary
         
        
        to fix an issue where
the module name is sometimes duplicated.
I.e.
        
         
          foo.bar.baz()
         
        
        became
        
         
          foo.bar.foo.bar.baz()
         
        
        , which of course doesn’t exist
and created a broken link.
       
{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 0.7.0.
         
          Changed in version 1.3.0:
         
         Autosummary now selects the appropriate documenter for attributes rather than
falling back to
         
          
           DataDocumenter
          
         
         .
        
         
          Changed in version 2.13.0:
         
         Also patches
         
          
           sphinx.ext.autodoc.ModuleDocumenter
          
         
         to fix an issue where
         
          
           __all__
          
         
         is not respected for autosummary tables.
        
Configuration ¶
- <{{ sig_prename_tag }} class="sig-name descname"> autodocsumm_member_order {{ sig_prename_tag }}> ¶
- 
          Type:strDefault:'alphabetical'Determines the sort order of members in autodocsummsummary tables. Valid values are'alphabetical'and'bysource'.Note that for 'bysource'the module must be a Python module with the source code available.The member order can also be set on a per-directive basis using the :member-order: [order]option. This applies not only toautomoduleetc. directives, but also toautomodulesummetc. directives.
- <{{ sig_prename_tag }} class="sig-name descname"> autosummary_col_type {{ sig_prename_tag }}> ¶
- 
          Type:strDefault:'\X'The LaTeX column type to use for autosummary tables. Custom columns can be defined in the LaTeX preamble for use with this option. For example: latex_elements["preamble"] = r''' \makeatletter \newcolumntype{\Xx}[2]{>{\raggedright\arraybackslash}p{\dimexpr (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}} \makeatother ''' autosummary_col_type = "\\Xx" {% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 2.13.0.