From 51224704728993f9825d538a0d50f5dd9312b22e Mon Sep 17 00:00:00 2001
From: Peter Magnusson <peter@wselcon.se>
Date: Wed, 24 Apr 2019 15:46:47 +0200
Subject: Add sphinx-autobuild to docker

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 87484405..4815e495 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,17 @@ Required Debian Packages:
 * `texlive-fonts-recommended`
 * `texlive-latex-extra`
 
+### sphinx-autobuild
+Required extra setup procedure on Debian:
+```bash
+sudo apt-get install python-pip
+sudo pip install sphinx-autobuild
+```
+
+To build and run a webeserver, inside the `docs` folder:
+* `make livehtml` and browse to http://localhost:8000
+
+
 ## Docker
 
 Using our [Dockerfile](docker/Dockerfile) you create your own Docker container
@@ -34,4 +45,16 @@ $ docker build -t vyos-docu docker
 Linux
 ```bash
 $ 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
+```powershell
+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 vyos-docu make livehtml
+```
+
-- 
cgit v1.2.3