Skip to content

Commit b26028b

Browse files
committed
Internalized 'docsgen' package
1 parent 3bbc5c4 commit b26028b

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ on:
2121
- "go.sum"
2222
- "Taskfile.ya?ml"
2323
- "**.go"
24-
- "docsgen/**"
24+
- "internal/docsgen/**"
2525
- "rpc/**"
2626
- "mkdocs.ya?ml"
2727
- "poetry.lock"

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ __debug_bin*
2828
# Mkdocs
2929
/site/
3030
/public/
31-
/docsgen/arduino-cli
32-
/docsgen/arduino-cli.exe
31+
/internal/docsgen/arduino-cli
32+
/internal/docsgen/arduino-cli.exe
3333
/docs/rpc/*.md
3434
/docs/commands/*.md
3535
/docs/configuration.schema.json

Taskfile.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ tasks:
5353
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-cobra-mkdocs-versioned-poetry/Taskfile.yml
5454
go:cli-docs:
5555
desc: Generate command line interface reference documentation
56-
dir: ./docsgen
56+
dir: ./internal/docsgen
5757
cmds:
5858
# Command examples use os.Args[0] so the docs generation binary must have the same filename as the project
5959
- go build -o {{.PROJECT_NAME}}{{exeExt}}
6060
# The binary is invoked like this instead of `./{{.PROJECT_NAME}}` to remove the `./` chars from the examples
61-
- PATH=. {{.PROJECT_NAME}} ../docs/commands
61+
- PATH=. {{.PROJECT_NAME}} ../../docs/commands
6262

6363
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
6464
go:fix:
File renamed without changes.

internal/i18n/data/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ at the source:
77

88
- **en.po** - edit the string in the source code file indicated by the comment above it <br /> e.g., a comment
99
`#: commands/upload/upload.go:615` indicates the source string is at line 615 of the file
10-
[`commands/upload/upload.go`](../../commands/upload/upload.go)
10+
[`commands/upload/upload.go`](../../../commands/upload/upload.go)
1111
- **All other files** - the localization is done on **Transifex**: <br />
1212
https://explore.transifex.com/arduino-1/arduino-cli/

0 commit comments

Comments
 (0)