From 803e178d14ec55f30ff62b16657d81b7ecd3cc95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Thu, 22 Aug 2019 21:47:52 +0200 Subject: [PATCH] Add hint about sphinx-autobuild MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- README.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.rst b/README.rst index e4e1a2672..8e9e169e2 100644 --- a/README.rst +++ b/README.rst @@ -82,6 +82,12 @@ Building To change into this environment you need to run `pipenv shell` to launch the shell and to exit you can use either `exit` or `Ctrl` + `D`. +When editing the documentation installing `sphinx-autobuild` though pip can be helpful. This will watch file changes and automatically reload the html preview: + +1. Install `pip2 install sphinx-autobuild` +2. Enter the documentation section `cd user_manual` +3. Watch for file changes `make SPHINXBUILD=sphinx-autobuild html` +4. Open http://127.0.0.1:8000 in the browser and start editing Icons -----