search

dragonflyoss / Dragonfly

This repository has be archived and moved to the new repository https://github.com/dragonflyoss/Dragonfly2.
https://d7y.io
Apache License 2.0
6k stars 774 forks source link

docs: auto generate Dragonfly cli/api/contributors docs via code #1505

Closed pouchrobot closed 4 years ago

pouchrobot commented 4 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: make build && make install && make docs

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.