khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add hint about sphinx-autobuild

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl
2019-08-22 21:47:52 +02:00
parent 1560c83327
commit 803e178d14
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@@ -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
-----