Commit Graph

5 Commits

Author SHA1 Message Date
Link Dupont
6373f5bf65
feat(docs): Include Description and UsageText in docs output (#1287)
Include Description as part of the DESCRIPTION section, and put UsageText (if it is non-zero) into the Usage subsection.
2021-07-06 20:20:47 -04:00
Derek Smith
581b769cf3
feat(docs): add UsageText to docs output for markdown and man page generation (#1171)
* feat(docs): add UsageText to docs output for markdown and man page generation

* feat(docs): updated tests, DRYd up code, cleaned up string logic

* fix(lint): fixed go1.15 lint errors
2021-05-20 21:04:51 -04:00
Sascha Grunert
5b3508d95e
Fix man page heading formatting
Closes #1040

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
2020-01-15 08:51:07 +01:00
Sascha Grunert
2cb62f5091
Improve docs generation for cli.Authors
This allows specifying multiple authors, whereas no available authors
will be formatted correctly now.

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
2019-11-09 11:32:34 +01:00
Sascha Grunert
40d4a25a01
Add markdown and man page docs generation methods
This adds two new methods to the `App` struct:

- `ToMarkdown`: creates a markdown documentation string
- `ToMan`: creates a man page string

Signed-off-by: Sascha Grunert <mail@saschagrunert.de>
2019-08-07 14:02:28 +02:00