auto doc builder notes

pull/144/head
Tom Dyson 2014-03-11 17:39:08 +00:00
rodzic 71c78a53d6
commit dc2147013a
1 zmienionych plików z 3 dodań i 6 usunięć

Wyświetl plik

@ -7,13 +7,10 @@ These are Sphinx docs, automatically built at http://docs.wagtail.io when the ma
Then ``make html`` from this directory, and open ``_build/html/index.html`` in your browser.
To auto-build your local docs when you save:
We've provided a watchdog script (based on @jacobian's [snippet](http://jacobian.org/writing/auto-building-sphinx/)) to auto-build your local docs when you save them. Install watchdog:
pip install watchdog
$ watchmedo shell-command \
--patterns="*.rst" \
--ignore-pattern='_build/*' \
--recursive \
--command='make html'
Then run ``./autobuild.sh`` before you start editing.
The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.