Skip to main content

setup

Setup Sphinx extension.

def setup(
app: sphinx.application.Sphinx
) - > dict

Setup Sphinx extension.

Parameters​

NameTypeDescription
appsphinx.application.SphinxThe Sphinx application instance used to register documenters, directives, roles, and configuration values.

Returns​

TypeDescription
dictA dictionary containing extension metadata, specifically marking the extension as safe for parallel reading.