mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-15 15:09:55 +00:00
3b8591bcc8
* Updated documentation tool Added templates Updated documentation using tool * Fixed incorrect version in web README * Added new templates to tool. Updated documents in templates across the code base. Used tool to regenerate documentation.
24 lines
696 B
Cheetah
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}}
|