test: doc generation for root command

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
docker · Apr 23, 2024 · 9712509 · 9712509
1 parent adf75cb
commit 9712509
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 4 deletions.
diff --git a/clidocstool_man_test.go b/clidocstool_man_test.go
@@ -43,7 +43,7 @@ func TestGenManTree(t *testing.T) {
 	c, err := New(Options{
 		Root:      dockerCmd,
 		SourceDir: tmpdir,
-		Plugin:    true,
+		Plugin:    false,
 		ManHeader: &doc.GenManHeader{
 			Title:   "DOCKER",
 			Section: "1",

diff --git a/clidocstool_md_test.go b/clidocstool_md_test.go
@@ -35,7 +35,7 @@ func TestGenMarkdownTree(t *testing.T) {
 	c, err := New(Options{
 		Root:      dockerCmd,
 		SourceDir: tmpdir,
-		Plugin:    true,
+		Plugin:    false,
 	})
 	require.NoError(t, err)
 	require.NoError(t, c.GenMarkdownTree(dockerCmd))

diff --git a/clidocstool_test.go b/clidocstool_test.go
@@ -237,7 +237,7 @@ func TestGenAllTree(t *testing.T) {
 	c, err := New(Options{
 		Root:      dockerCmd,
 		SourceDir: tmpdir,
-		Plugin:    true,
+		Plugin:    false,
 		ManHeader: &doc.GenManHeader{
 			Title:   "DOCKER",
 			Section: "1",

diff --git a/clidocstool_yaml_test.go b/clidocstool_yaml_test.go
@@ -33,7 +33,7 @@ func TestGenYamlTree(t *testing.T) {
 	c, err := New(Options{
 		Root:      dockerCmd,
 		SourceDir: tmpdir,
-		Plugin:    true,
+		Plugin:    false,
 	})
 	require.NoError(t, err)
 	require.NoError(t, c.GenYamlTree(dockerCmd))

diff --git a/fixtures/docker.1 b/fixtures/docker.1
@@ -0,0 +1,27 @@
+.nh
+.TH "DOCKER" "1" "Jan 2020" "Docker Community" "Docker User Manuals"
+
+.SH NAME
+.PP
+docker - A self-sufficient runtime for containers
+
+
+.SH SYNOPSIS
+.PP
+\fBdocker [OPTIONS] COMMAND [ARG...]\fP
+
+
+.SH DESCRIPTION
+.PP
+A self-sufficient runtime for containers
+
+
+.SH OPTIONS
+.PP
+\fB-h\fP, \fB--help\fP[=false]
+	help for docker
+
+
+.SH SEE ALSO
+.PP
+\fBdocker-attach(1)\fP, \fBdocker-buildx(1)\fP
diff --git a/fixtures/docker.md b/fixtures/docker.md
@@ -0,0 +1,16 @@
+# docker
+
+<!---MARKER_GEN_START-->
+A self-sufficient runtime for containers
+
+### Subcommands
+
+| Name                  | Description                                                                   |
+|:----------------------|:------------------------------------------------------------------------------|
+| [`attach`](attach.md) | Attach local standard input, output, and error streams to a running container |
+| [`buildx`](buildx.md) | Docker Buildx                                                                 |
+
+
+
+<!---MARKER_GEN_END-->
+
diff --git a/fixtures/docker.yaml b/fixtures/docker.yaml
@@ -0,0 +1,17 @@
+command: docker
+short: A self-sufficient runtime for containers
+long: A self-sufficient runtime for containers
+usage: docker [OPTIONS] COMMAND [ARG...]
+cname:
+    - docker attach
+    - docker buildx
+clink:
+    - docker_attach.yaml
+    - docker_buildx.yaml
+deprecated: false
+hidden: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+