AliyunContainerService / pouch

An Efficient Enterprise-class Container Engine
https://pouchcontainer.io
Apache License 2.0
4.64k stars 949 forks source link

docs: auto generate pouch cli/api/contributors docs via code #2997

Closed pouchrobot closed 5 years ago

pouchrobot commented 5 years ago

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.

codecov[bot] commented 5 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request head (auto-doc-2019-10-26@b5ca722). Click here to learn what that means. The diff coverage is n/a.

fuweid commented 5 years ago

duplicated with #2996