Skip to content

Commit 8fd2b26

Browse files
Massimiliano Pippimasci
Massimiliano Pippi
authored andcommitted
added command reference generator
1 parent 4b874a0 commit 8fd2b26

File tree

5 files changed

+318
-0
lines changed

5 files changed

+318
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ venv
2020

2121
# Misc.
2222
.DS_Store
23+
24+
# Mkdocs
25+
/public/
26+
/docsgen/arduino-cli

docsgen/Taskfile.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: '2'
2+
3+
tasks:
4+
gen:commands:
5+
desc: Generate commands reference
6+
cmds:
7+
# docs will generate examples using os.Args[0] so we need to call
8+
# the generator `arduino-cli`
9+
- go build -o arduino-cli
10+
# we invoke `arduino-cli` like this instead of `./arduino-cli` to remove
11+
# the `./` chars from the examples
12+
- PATH=. arduino-cli ../docs/commands

docsgen/go.mod

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module github.com/arduino/arduino-cli/docsgen
2+
3+
go 1.13
4+
5+
require (
6+
github.com/arduino/arduino-cli v0.0.0-20200228161349-4b874a02b096
7+
github.com/spf13/cobra v0.0.6
8+
)

0 commit comments

Comments
 (0)