Make man page show up in apropos

Set the 'description' attribute so that Sphinx builds the manpage with
the 'NAME' section. This is necessary for `apropos` to be able to find
yamllint

Fixes part of #76
This commit is contained in:
Andrew Imeson 2022-03-19 10:52:02 -04:00 committed by Adrien Vergé
parent c34c962691
commit 8a320aaf2c

View File

@ -39,7 +39,7 @@ htmlhelp_basename = 'yamllintdoc'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'yamllint', '', [u'Adrien Vergé'], 1)
('index', 'yamllint', 'Linter for YAML files', [u'Adrien Vergé'], 1)
]
# -- Build with sphinx automodule without needing to install third-party libs