autoaliasattr_directive

A directive for documenting type aliases and other module-level attributes.

Classes

AliasAttrDocumenter

Directive which replaces Sphinx's Autosummary for module-level attributes: instead, it manually crafts a new "Type Aliases" section, where all the module-level attributes which are explicitly annotated as TypeAlias are considered as such, for their use all around the Manim docs.

Functions

setup(app)[source]
Parameters:

app (Sphinx)

Return type:

None

smart_replace(base, alias, substitution)[source]

Auxiliary function for substituting type aliases into a base string, when there are overlaps between the aliases themselves.

Parameters:

  • base (str) – The string in which the type aliases will be located and replaced.

  • alias (str) – The substring to be substituted.

  • substitution (str) – The string which will replace every occurrence of alias.

Returns:

The new string after the alias substitution.

Return type:

str