argodocs

README

argodocs

argodocs is a tool to generate reference documentation for argo workflow templates.

Installation

go install github.com/rohankmr414/argodocs@latest

Add $GOPATH/bin to your $PATH or copy $GOPATH/bin/argodocs to your $PATH.

Usage

Usage:
  argodocs [command]

Available Commands:
  generate    Generate docs from workflow manifest.
  help        Help about any command

Flags:
  -h, --help   help for argodocs

Use "argodocs [command] --help" for more information about a command.

Generate

argodocs generate **/*.yaml --output-prefix=../docs/

Contributing

If you're interested in contributing to argodocs, check out CONTRIBUTING.md

License

Copyright (c) Rohan Kumar and Junaid Rahim. All rights reserved. Released under the MIT License