diff options
Diffstat (limited to 'doc/source/user/sphinxext.rst')
| -rw-r--r-- | doc/source/user/sphinxext.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/user/sphinxext.rst b/doc/source/user/sphinxext.rst index ae1cabe..46ac97e 100644 --- a/doc/source/user/sphinxext.rst +++ b/doc/source/user/sphinxext.rst @@ -125,6 +125,14 @@ Directive .. seealso:: The ``:ignored:`` directive option. + `autoprogram_cliff_app_dist_name` + The name of the python distribution (the name used with pip, as opposed to + the package name used for importing) providing the commands/applications + being documented. Generated documentation for plugin components includes + a message indicating the name of the plugin. Setting this option tells + cliff the name of the distribution providing components natively so their + documentation does not include this message. + .. seealso:: Module `sphinxcontrib.autoprogram` |