diff options
| author | Julius Härtl <jus@bitgrid.net> | 2019-08-22 22:47:52 +0300 |
|---|---|---|
| committer | Julius Härtl <jus@bitgrid.net> | 2019-08-22 22:47:52 +0300 |
| commit | 803e178d14ec55f30ff62b16657d81b7ecd3cc95 (patch) | |
| tree | c6751f81075485d716539846b1b0427c4d1e084c /README.rst | |
| parent | 1560c833277f08960dd708470dcae9aab2b306cd (diff) | |
Add hint about sphinx-autobuild
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 6 |
1 files changed, 6 insertions, 0 deletions
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 ----- |