mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
b949388994
* Add exchange manager to engine
* Several improvements for engine and friends
1) New file.Exists func
2) gRPC TLS cert expiration date check and regeneration
3) New donation var for use across the codebase
4) Use Go log package until the logger is initialised
* Add cert tests and create dir tree if it doesn't exist for file.Write
* Link up donation address to documentation tool plus minor adjustments
* Fix remaining donation addrs
* Move non-needed reload exchange funcs
* Revert accidental config_example.json changes 🕯️
* Use go logger for logging until the logger has initiliased, otherwise no output will be seen
* Link up portfolio delay val and other fixes
* Run go mod tidy after dependabot PR
* Address nitterinos
64 lines
2.6 KiB
Cheetah
64 lines
2.6 KiB
Cheetah
{{define "cmd documentation" -}}
|
|
{{template "header" .}}
|
|
## Current Features for {{.Name}}
|
|
|
|
#### This tool allows for the generation of new documentation through templating
|
|
|
|
From the `gocryptotrader/cmd/documentation/` folder, using the go command: **go run documentation.go** this will auto-generate and regenerate documentation across the **GoCryptoTrader** code base.
|
|
>Using the -v command will, ie **go run documentation.go -v** put the tool into verbose mode allowing you to see what is happening with a little more depth.
|
|
|
|
Be aware, this tool will:
|
|
- Works off a configuration JSON file located at ``gocryptotrader/cmd/documentation/`` for future use with multiple repositories.
|
|
- Automatically find the directory and file tree for the GoCryptoTrader source code and alert you of undocumented file systems which **need** to be updated.
|
|
- Automatically find the template folder tree.
|
|
- Fetch an updated contributor list and rank on pull request commit amount
|
|
- Sets up core folder docs for the root directory tree including **LICENSE** and **CONTRIBUTORS**
|
|
|
|
### config.json example
|
|
|
|
```json
|
|
{
|
|
"githubRepo": "https://api.github.com/repos/thrasher-corp/gocryptotrader", This is your current repo
|
|
"exclusionList": { This allows for excluded directories and files
|
|
"Files": null,
|
|
"Directories": [
|
|
"_templates",
|
|
".git",
|
|
"web"
|
|
]
|
|
},
|
|
"rootReadmeActive": true, allows a root directory README.md
|
|
"licenseFileActive": true, allows for a license file to be generated
|
|
"contributorFileActive": true, fetches a new contributor list
|
|
"referencePathToRepo": "../../"
|
|
}
|
|
```
|
|
### Template example
|
|
>place a new template **example_file.tmpl** located in the current gocryptotrader/cmd/documentation/ folder; when the documentation tool finishes it will give you the define template associated name e.g. ``Template not found for path ../../cmd/documentation create new template with \{\{define "cmd documentation" -\}\} TEMPLATE HERE \{\{end}}`` so you can replace the below example with ``\{\{define "cmd documentation" -}}``
|
|
|
|
```
|
|
\{\{\define "example_definition_created_by_documentation_tool" -}}
|
|
\{\{\template "header" .}}
|
|
## Current Features for {{.Name}}
|
|
|
|
#### A concise blurb about the package or tool system
|
|
|
|
+ Coding examples
|
|
import "github.com/thrasher-corp/gocryptotrader/something"
|
|
testString := "aAaAa"
|
|
upper := strings.ToUpper(testString)
|
|
// upper == "AAAAA"
|
|
|
|
{\{\template "contributions"}}
|
|
{\{\template "donations"}}
|
|
{\{\end}}
|
|
```
|
|
|
|
### ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED.
|
|
|
|
|
|
### Please click GoDocs chevron above to view current GoDoc information for this package
|
|
{{template "contributions"}}
|
|
{{template "donations" .}}
|
|
{{end}}
|