vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-11-02 20:02:05 +01:00
Code Issues Packages Projects Releases Wiki Activity
vyos-documentation/README.md
Christian Poessinger 10deb82cbf Update README.md with Docker build instructions
2018-10-07 14:47:22 +02:00

695 B
Raw Blame History

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

Docker

Create Container

$ docker build -t vyos-docu - < Dockerfile

Build Documentation

$ docker run -v `pwd`:`pwd` -w `pwd`/docs -i -t --rm vyos-docu bash

Inside the container you can the build the documentation as stated above