Files
gocryptotrader/cmd/documentation/tools_templates/documentation_tool.tmpl
Adrian Gallagher f5914e8c10 Engine changes
2019-05-22 17:06:38 +10:00

24 lines
696 B
Cheetah

{{define "tools documentation" -}}
{{template "header" .}}
## Documentation Management Tool
### Current Features
+ Retrieves contribution activity via github API
+ Regenerates and updates documentation across the entire code base for each individual package
+ Allows for a documentation standard across this codebase
#### How to example
+ This will update the entire codebase when a change is made in the documentation templates
```sh
cd $GOPATH/src/github.com/thrasher-/gocryptotrader/tools/documentation/
go run gocryptotrader.go -r
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}