docs(cli): add auto-generated CLI reference #1209
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #1209 +/- ##
=======================================
Coverage 77.56% 77.56%
=======================================
Files 11 11
Lines 2826 2826
=======================================
Hits 2192 2192
Misses 634 634 Continue to review full report at Codecov.
|
max-wittig
reviewed
Oct 12, 2020
|
Very nice! |
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 adds a generated page similar to the API reference, including all the possible commands. It's a long list, but better than nothing. 😁 I wasn't able to group them into sections due to the way they are currently dynamically generated, but maybe there's a way.
I've noticed a lot of people still use the CLI even though it has some issues. I'm hoping this can help people/prevent opening issues that are simply due to missing docs (recent example: #1197), or at least we can more quickly close those by providing the link rather than providing examples every time.
Also means no more manual examples for the CLI are needed, hopefully.
Click also has a drop-in replacement for the sphinx extension used for this PR, so switching at a later point should be easy.
Closes #1197.