autoapi.sphinx

Glue for Sphinx API.

Functions

  • builder_inited(): autoapi Sphinx extension hook for the builder-inited event.
  • setup(): autoapi Sphinx extension setup.
autoapi.sphinx.builder_inited(app)

autoapi Sphinx extension hook for the builder-inited event.

This hook will read the configuration value autoapi_modules and render the modules described in it.

See http://sphinx-doc.org/extdev/appapi.html#event-builder-inited

autoapi.sphinx.setup(app)

autoapi Sphinx extension setup.

See http://sphinx-doc.org/extdev/tutorial.html#the-setup-function