Skip to content
VyOS readthedocs
Dockerfile Shell
Branch: master
Clone or download
c-po Merge pull request #131 from kroy-the-rabbit/master
Adding missing sync group documentation
Latest commit c1ee40a Oct 16, 2019

README.md

This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux) release.

Build

Native

To build the manual run the following commands inside the docs folder:

  • make html for a HTML manual
  • make 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

sphinx-autobuild

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:

Docker

Using our Dockerfile you create your own Docker container that is used to build a VyOS documentation.

Setup

$ docker build -t vyos-docu docker

Build

Linux

$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu 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-docu make livehtml

Windows

docker run --rm -it -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make html

# sphinx autobuild
docker run --rm -it -p 8000:8000 -v "$(pwd):/vyos" -w /vyos/docs vyos-docu make livehtml

Test the docs

discuss in this Task: T1731

to test all files:

$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu 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-docu vale clustering.rst
You can’t perform that action at this time.