diff options
author | Christian Poessinger <christian@poessinger.com> | 2018-10-07 14:47:22 +0200 |
---|---|---|
committer | Christian Poessinger <christian@poessinger.com> | 2018-10-07 14:47:22 +0200 |
commit | 10deb82cbf0f63c6e7012a94fc2a7eead999ffea (patch) | |
tree | 8fc74ca33ed7ff55ade0915e6998c0edf072ee33 /README.md | |
parent | 008377c0ec89b30fc19f27b190c18d9051c7d0ef (diff) | |
download | vyos-documentation-10deb82cbf0f63c6e7012a94fc2a7eead999ffea.tar.gz vyos-documentation-10deb82cbf0f63c6e7012a94fc2a7eead999ffea.zip |
Update README.md with Docker build instructions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
@@ -1,7 +1,35 @@ 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 + +```bash +$ docker build -t vyos-docu - < Dockerfile +``` + +### Build Documentation + +```bash +$ 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 |