File tree 1 file changed +9
-9
lines changed
1 file changed +9
-9
lines changed Original file line number Diff line number Diff line change @@ -90,26 +90,26 @@ If the `vyos/vyos-documentation` container could not be found locally it will be
90
90
automatically fetched from Dockerhub.
91
91
92
92
``` bash
93
- $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs \
94
- -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation make html
93
+ $ git clone https://github.com/vyos/vyos-documentation.git
95
94
96
- # sphinx autobuild
97
- $ docker run --rm -it -p 8000:8000 -v " $( pwd) " :/vyos -w /vyos/docs -e \
98
- GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation make livehtml
95
+ $ cd vyos-documentation
96
+
97
+ $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation make html
98
+
99
+ # For sphinx autobuild
100
+ $ docker run --rm -it -p 8000:8000 -v " $( pwd) " :/vyos -w /vyos/docs -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation make livehtml
99
101
```
100
102
101
103
### Test the docs
102
104
103
105
To test all files, run:
104
106
105
107
``` bash
106
- $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs \
107
- -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation vale .
108
+ $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation vale .
108
109
```
109
110
110
111
to test a specific file (e.g. ` quick-start.rst ` )
111
112
112
113
``` bash
113
- $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs -e GOSU_UID=$( id -u) \
114
- -e GOSU_GID=$( id -g) vyos/vyos-documentation vale quick-start.rst
114
+ $ docker run --rm -it -v " $( pwd) " :/vyos -w /vyos/docs -e GOSU_UID=$( id -u) -e GOSU_GID=$( id -g) vyos/vyos-documentation vale quick-start.rst
115
115
```
You can’t perform that action at this time.
0 commit comments