wagtail/docs
Karl Hobley 14228a56e1 Merge pull request #419 from gasman/serve_preview
Use serve_preview() rather than serve() for all preview / moderation / view_draft actions
2014-07-03 17:22:22 +01:00
..
_static/css
building_your_site Deprecate the `show_as_mode` method in favour of `serve_preview` which additionally takes a 'request' argument 2014-07-03 15:31:27 +01:00
editor_manual
images
Makefile
README.md
advanced_topics.rst
autobuild.sh
conf.py
contributing.rst
deploying.rst
editing_api.rst update hook examples in docs to import from wagtailcore, not wagtailadmin 2014-07-02 20:04:06 +01:00
form_builder.rst
frontend_cache_purging.rst frontend cache purge docs change 2014-07-03 13:10:03 +01:00
gettingstarted.rst
index.rst Update index.rst 2014-07-03 12:26:48 +01:00
management_commands.rst
model_recipes.rst Deprecate the `show_as_mode` method in favour of `serve_preview` which additionally takes a 'request' argument 2014-07-03 15:31:27 +01:00
performance.rst
roadmap.rst
settings.rst
sitemap_generation.rst
snippets.rst
static_site_generation.rst Rearrange static site generation docs 2014-07-03 12:53:11 +01:00
support.rst
wagtail_search.rst

README.md

Wagtail docs

These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Sphinx and the RTD theme:

pip install Sphinx
pip install sphinx-rtd-theme

Then make html from this directory, and open _build/html/index.html in your browser.

We've provided a watchdog script (based on @jacobian's snippet) to auto-build your local docs when you save them. Install watchdog:

pip install watchdog

Then run ./autobuild.sh before you start editing.

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.