glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-05 21:07:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

add reference to rest docs in readme

Browse source
This commit is contained in:
Shahidh 2017-10-07 20:59:13 +05:30
parent 5f7b6e7380
commit 83e1b0eeb5
No known key found for this signature in database
GPG key ID: 9903E455C1B45ECD
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -906,6 +906,10 @@ Run 'kubectl help' for usage.
Cobra can generate a Markdown-formatted document based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [Markdown Docs](doc/md_docs.md).
## Generating reStructured Text-formatted documentation for your command
Cobra can generate a reStructured Text-formatted document based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [ReST Docs](doc/rest_docs.md).
## Generating man pages for your command
Cobra can generate a man page based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [Man Docs](doc/man_docs.md).