Sphinx¶

The Sphinx contrib plugin adds a directive that can be used to document extensions to the Doozer command line interface.

class doozer.contrib.sphinx.DoozerCLIDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

A Sphinx directive that can be used to document a CLI extension.

This class wraps around autoprogram to generate Sphinx documentation for extensions that extend the Doozer CLI.

.. doozercli:: doozer_database:Database
   :start_command: db

New in version 1.1.0.

Changed in version 1.2.0: The prog option will default to the proper way to invoke command line extensions.

For full details of the options support by the doozercli directive, please refer to the sphinxcontrib-autoprogram documentation.