mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-14 07:26:47 +00:00
24 lines
700 B
Cheetah
24 lines
700 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-corp/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}}
|