Skip to content

Commit 7142e86

Browse files
committed
test: doc generation for root command
Signed-off-by: David Karlsson <[email protected]>
1 parent ea2c7ca commit 7142e86

File tree

7 files changed

+64
-4
lines changed

7 files changed

+64
-4
lines changed

clidocstool_man_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func TestGenManTree(t *testing.T) {
4343
c, err := New(Options{
4444
Root: dockerCmd,
4545
SourceDir: tmpdir,
46-
Plugin: true,
46+
Plugin: false,
4747
ManHeader: &doc.GenManHeader{
4848
Title: "DOCKER",
4949
Section: "1",

clidocstool_md_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func TestGenMarkdownTree(t *testing.T) {
3535
c, err := New(Options{
3636
Root: dockerCmd,
3737
SourceDir: tmpdir,
38-
Plugin: true,
38+
Plugin: false,
3939
})
4040
require.NoError(t, err)
4141
require.NoError(t, c.GenMarkdownTree(dockerCmd))

clidocstool_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ func TestGenAllTree(t *testing.T) {
237237
c, err := New(Options{
238238
Root: dockerCmd,
239239
SourceDir: tmpdir,
240-
Plugin: true,
240+
Plugin: false,
241241
ManHeader: &doc.GenManHeader{
242242
Title: "DOCKER",
243243
Section: "1",

clidocstool_yaml_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func TestGenYamlTree(t *testing.T) {
3333
c, err := New(Options{
3434
Root: dockerCmd,
3535
SourceDir: tmpdir,
36-
Plugin: true,
36+
Plugin: false,
3737
})
3838
require.NoError(t, err)
3939
require.NoError(t, c.GenYamlTree(dockerCmd))

fixtures/docker.1

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.nh
2+
.TH "DOCKER" "1" "Jan 2020" "Docker Community" "Docker User Manuals"
3+
4+
.SH NAME
5+
.PP
6+
docker - A self-sufficient runtime for containers
7+
8+
9+
.SH SYNOPSIS
10+
.PP
11+
\fBdocker [OPTIONS] COMMAND [ARG...]\fP
12+
13+
14+
.SH DESCRIPTION
15+
.PP
16+
A self-sufficient runtime for containers
17+
18+
19+
.SH OPTIONS
20+
.PP
21+
\fB-h\fP, \fB--help\fP[=false]
22+
help for docker
23+
24+
25+
.SH SEE ALSO
26+
.PP
27+
\fBdocker-attach(1)\fP, \fBdocker-buildx(1)\fP

fixtures/docker.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# docker
2+
3+
<!---MARKER_GEN_START-->
4+
A self-sufficient runtime for containers
5+
6+
### Subcommands
7+
8+
| Name | Description |
9+
|:----------------------|:------------------------------------------------------------------------------|
10+
| [`attach`](attach.md) | Attach local standard input, output, and error streams to a running container |
11+
| [`buildx`](buildx.md) | Docker Buildx |
12+
13+
14+
15+
<!---MARKER_GEN_END-->
16+

fixtures/docker.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
command: docker
2+
short: A self-sufficient runtime for containers
3+
long: A self-sufficient runtime for containers
4+
usage: docker [OPTIONS] COMMAND [ARG...]
5+
cname:
6+
- docker attach
7+
- docker buildx
8+
clink:
9+
- docker_attach.yaml
10+
- docker_buildx.yaml
11+
deprecated: false
12+
hidden: false
13+
experimental: false
14+
experimentalcli: false
15+
kubernetes: false
16+
swarm: false
17+

0 commit comments

Comments
 (0)