From 10deb82cbf0f63c6e7012a94fc2a7eead999ffea Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 7 Oct 2018 14:47:22 +0200 Subject: Update README.md with Docker build instructions --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index ca18e5d6..deed63e7 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3