Use text from debian man pages for CLI help output.#395
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## trunk #395 +/- ##
=======================================
Coverage 97.85% 97.85%
=======================================
Files 22 22
Lines 1399 1400 +1
Branches 130 130
=======================================
+ Hits 1369 1370 +1
Misses 15 15
Partials 15 15
Continue to review full report at Codecov.
|
Member
Author
|
I think that this is ready for review. |
hynek
approved these changes
Aug 17, 2022
Member
Author
|
Thanks for the review. I realized now that the README or the docs don't talk about click or click-man. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This tries to fixes #384
The idea is that instead of having a separate
manfile that duplicated the CLI info from the Python script, we should only have the help content in the python script.From there, we can export it to
manorsphinx.For this PR I am using the help content from #326
Debian and other distrubtion can run
click-man towncrierto generate the man content.click-man has more info for Debian at https://github.com/click-contrib/click-man#debian-packages
The result of this PR
main commnad
build command
check command
create command