cfme.utils.apidoc module

Sphinx plugin for automatically generating (and optionally cleaning) project api documentation

To enable the optional cleaning, set clean_autogenerated_docs to True in docs/conf.py

cfme.utils.apidoc.modules_to_document = ['cfme']

List of modules/packages to document, paths relative to the project root.

cfme.utils.apidoc.purge_module_apidoc(sphinx, exception)

cfme.utils.apidoc.setup(sphinx)

Main sphinx entry point, calls sphinx-apidoc