limnoria-plugin-doc1
Generates the documentation for a limnoria plugin
Usage
limnoria-plugin-doc [options]
Overview
limnoria-plugin-doc is used to generate documentation (StructuredText or reStructuredText format) for a limnoria(1) plugin.
Options
-
--version -
Show version of program.
-
-h, --help -
Show summary of options.
-
-c, --clean -
Clean the various data/conf/log directories after generating the docs.
-
-o, --output-dir=OUTPUTDIR -
Specifies the directory in which to write the documentation for the plugin.
-
-f, --format=FORMAT -
Specifies which output format to use. Choices are 'rst' or 'stx'.
-
--plugins-dir=PLUGINSDIRS -
Looks in the given directory for plugins and generates documentation for all of them.