vinchent/cobra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add ReST doc generation (#537)

Browse Source
This commit is contained in:
Shahidh K Muhammed
2017-10-07 23:09:47 +05:30
committed by Albert Nigmatzianov
parent bc69223348
commit 419e0f8d51
4 changed files with 429 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -42,8 +42,7 @@ Many of the most widely used Go projects are built using Cobra including:
* [Usage Message](#usage-message)
* [PreRun and PostRun Hooks](#prerun-and-postrun-hooks)
* [Suggestions when "unknown command" happens](#suggestions-when-unknown-command-happens)
* [Generating Markdown-formatted docs](#generating-markdown-formatted-docs)
* [Generating man pages](#generating-man-pages)
* [Generating documentation for your command](#generating-documentation-for-your-command)
* [Generating bash completions](#generating-bash-completions)
- [Contributing](#contributing)
- [License](#license)
@ -682,13 +681,13 @@ Did you mean this?
Run 'kubectl help' for usage.
```
## Generating Markdown-formatted docs
## Generating documentation for your command
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).
Cobra can generate documentation based on subcommands, flags, etc. in the following formats:
## Generating man pages
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).
- [Markdown](doc/md_docs.md)
- [ReStructured Text](doc/rest_docs.md)
- [Man Page](doc/man_docs.md)
## Generating bash completions