API
This is the front page for the API documentation. It uses the special
directive ::: identifier
provided by MkDocstrings.
There is no equivalent for Sphinx's Autosummary, so we have to create the summary ourselves.
action
|
Manual synopsis of function action .
|
actions
|
Manual synopsis of module actions .
|
classes
|
Manual synopsis of module classes .
|
This does not add them to the navigation in the side bar. We have to do
that manually, by editing mkdocs.yml
, unless we make use of the
MkDocs-gen-files plug-in and create these pages on the fly.