docs: auto generate pouch cli/api/contributors docs via code #2893
Conversation
This file contains 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
Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
Codecov Report
|
|
LGTM |
pouchrobot
added
the
LGTM
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.
Signed-off-by: pouchrobot pouch-dev@alibaba-inc.com
1.Describe what this PR did
This PR is automatically done by AI-based collaborating robot.
Pouchrobot will auto-generate cli/api document via https://github.com/spf13/cobra/tree/master/doc every day.
2.Does this pull request fix one issue?
None
3.Describe how you did it
We use the following user input CLI document generating command in pouchrobot to generate CLI doc:
go build -o /usr/bin/pouch ./cli; pouch gen-doc
For API part, we use a tool swagger2markup to make it.
4.Describe how to verify it
None
5.Special notes for reviews
The cli/api doc must be automatically generated.