d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-06-04 23:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation tool (#155)

Browse Source 
* 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.
This commit is contained in:
Ryan O'Hara-Reid
2018-07-19 16:02:24 +10:00
committed by Adrian Gallagher
parent aaf9f52a70
commit 3b8591bcc8
148 changed files with 8201 additions and 477 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
tools/documentation/tools_templates/documentation_tool.tmpl Normal file
View File

@@ -0,0 +1,23 @@
{{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}}