Skip to content

docs: move doc generation scripts to subdir #3991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thaJeztah merged 1 commit into from
Jan 31, 2023
Merged

docs: move doc generation scripts to subdir #3991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/generate.go → docs/generate/generate.go
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/go.mod → docs/generate/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/docker/cli/docs
module github.com/docker/cli/docs/generate

// dummy go.mod to avoid dealing with dependencies specific
// to docs generation and not really part of the project.
Expand All @@ -10,4 +10,4 @@ go 1.16
// github.com/docker/cli-docs-tool v0.5.0
//)
//
//replace github.com/docker/cli v0.0.0+incompatible => ../
//replace github.com/docker/cli v0.0.0+incompatible => ../../
0 docs/tools.go → docs/generate/tools.go
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions scripts/docs/generate-yaml.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ trap clean EXIT
# install cli-docs-tool and copy docs/tools.go in root folder
# to be able to fetch the required depedencies
go mod edit -modfile=vendor.mod -require=github.com/docker/cli-docs-tool@${CLI_DOCS_TOOL_VERSION}
cp docs/tools.go .
cp docs/generate/tools.go .
# update vendor
./scripts/vendor update
# build docsgen
go build -mod=vendor -modfile=vendor.mod -tags docsgen -o /tmp/docsgen ./docs/generate.go
go build -mod=vendor -modfile=vendor.mod -tags docsgen -o /tmp/docsgen ./docs/generate/generate.go
)

mkdir -p docs/yaml
Expand Down