From 1e3622c50cc80bb578c59dc242630ee815e678fd Mon Sep 17 00:00:00 2001 From: David Karlsson Date: Fri, 27 Jan 2023 15:25:28 +0100 Subject: [PATCH] docs: move doc generation scripts to subdir Signed-off-by: David Karlsson --- docs/{ => generate}/generate.go | 0 docs/{ => generate}/go.mod | 4 ++-- docs/{ => generate}/tools.go | 0 scripts/docs/generate-yaml.sh | 4 ++-- 4 files changed, 4 insertions(+), 4 deletions(-) rename docs/{ => generate}/generate.go (100%) rename docs/{ => generate}/go.mod (69%) rename docs/{ => generate}/tools.go (100%) diff --git a/docs/generate.go b/docs/generate/generate.go similarity index 100% rename from docs/generate.go rename to docs/generate/generate.go diff --git a/docs/go.mod b/docs/generate/go.mod similarity index 69% rename from docs/go.mod rename to docs/generate/go.mod index 66010b7e9eac..d62ff455713a 100644 --- a/docs/go.mod +++ b/docs/generate/go.mod @@ -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. @@ -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 => ../../ diff --git a/docs/tools.go b/docs/generate/tools.go similarity index 100% rename from docs/tools.go rename to docs/generate/tools.go diff --git a/scripts/docs/generate-yaml.sh b/scripts/docs/generate-yaml.sh index 03def23a4aa1..4d0006e43e79 100755 --- a/scripts/docs/generate-yaml.sh +++ b/scripts/docs/generate-yaml.sh @@ -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