From dc2147013a5f88ff65791498f1789ad5715e62ca Mon Sep 17 00:00:00 2001 From: Tom Dyson Date: Tue, 11 Mar 2014 17:39:08 +0000 Subject: [PATCH] auto doc builder notes --- docs/README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index df049de5f..00df97ba5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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.