Skip to content

Commit

Permalink
auto doc builder notes
Browse files Browse the repository at this point in the history
  • Loading branch information
tomdyson committed Mar 11, 2014
1 parent 71c78a5 commit dc21470
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit dc21470

Please sign in to comment.