Skip to content
master
Go to file
Code

README.md

Starting with VyOS 1.2 (crux) documentation will be migrated from the old wiki to ReadTheDocs. Documentation can be accessed via the following URL:

Build

Documentation Status

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:

  • latexmk
  • texlive-latex-recommended
  • texlive-fonts-recommended
  • texlive-latex-extra
  • sphinx

sphinx

Debian, requires some extra steps for installing sphinx, sphinx-autobuild and sphinx-rtd-theme packages:

First ensure that phython2 & phython3 are installed and phython3 is the default:

python --version

Alternatively, to make python3 the default, revise the following line to point to the relevant 3.x version of the binary on your system:

sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 0

Then follow these steps to install sphinx group of packages:

sudo apt-get install python3-sphinx

Although mostly everything uses phython3, But to install this specific package, make sure that pip points to the python2 version of the package manager:

python --version

Then run:

sudo pip install sphinx-rtd-theme

Do the following to build the html and start a webeserver:

  • Run make livehtml inside the docs folder

Then, to view the live output:

  • Browse to http://localhost:8000 Note: The changes you save to the sources are represented in the live HTML outout automatically (and almost instantly) without the need to rebuild or refresh manually.

Docker

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

Setup

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

Build documentation

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

Test the docs

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
You can’t perform that action at this time.