From 8a320aaf2ced24c832634c12e03d413879635836 Mon Sep 17 00:00:00 2001 From: Andrew Imeson Date: Sat, 19 Mar 2022 10:52:02 -0400 Subject: [PATCH] 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 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c651cf9..f5d317e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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