Starting with VyOS 1.2 (crux
) documentation will be migrated from the old wiki
to ReadTheDocs. Documentation can be accessed via the following URLs:
To build the manual run the following commands inside the docs
folder:
make html
for a HTML manualmake latexpdf
for a LaTeX rendered PDF
Required Debian Packages:
python-sphinx
python-sphinx-rtd-theme
latexmk
texlive-latex-recommended
texlive-fonts-recommended
texlive-latex-extra
Required extra setup procedure on Debian:
sudo apt-get install python-pip
sudo pip install sphinx-autobuild
To build and run a webeserver, inside the docs
folder:
make livehtml
and browse to http://localhost:8000
Using our Dockerfile you create your own Docker container that is used to build a VyOS documentation.
You can either build the container on your own or directly fetch it prebuild from Dockerhub. If you want to build it for yourself, use the following command.
$ docker build -t vyos/vyos-documentation docker
If the vyos/vyos-documentation
container could not be found locally it will be
automatically fetched from Dockerhub.
$ 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
# sphinx autobuild
$ 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
Discuss in this Phabricator task: T1731
To test all files run:
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \
-e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
to test a specific file e.g. clustering.rst
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \
-e GOSU_GID=$(id -g) vyos/vyos-documentation vale clustering.rst