kopia lustrzana https://github.com/wagtail/wagtail
auto doc builder notes
rodzic
71c78a53d6
commit
dc2147013a
|
@ -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.
|
||||
|
|
Ładowanie…
Reference in New Issue