sphinx-toolbox Demo - :no-docstring:

typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. <{{ sig_prename_tag }} class="sig-name descname"> Animal [source]

Optional keys common to all animals.

Required Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • name ( str ) – The name of the animal

Optional Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • voice ( str ) – The animal’s voice.

typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. <{{ sig_prename_tag }} class="sig-name descname"> Bird [source]

A bird.

Required Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • egg_size ( float ) – The size of the bird’s egg, in mm.

  • name ( str ) – The name of the animal

Optional Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • voice ( str ) – The animal’s voice.

typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. <{{ sig_prename_tag }} class="sig-name descname"> Cat [source]

A cat.

Required Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • fur_color ( str ) – The colour of the cat’s fur.

  • name ( str ) – The name of the animal

Optional Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • voice ( str ) – The animal’s voice.

typeddict <{{ sig_prename_tag }} class="sig-prename descclassname"> autotypeddict_demo. <{{ sig_prename_tag }} class="sig-name descname"> Movie [source]

Represents a movie.

Required Keys{% if docutils_version >= (0, 18) %} : {% endif %}
  • name ( str ) – The name of the animal

  • year ( int ) – The movie’s release year.

  • based_on ( str )