wagtail/docs
georgewhewell ebf2d767e0 Update docs for static site generation
the staticsitegen command won't work without these settings- will throw NotImplementedErrors using defaults.
2015-04-16 10:56:29 +01:00
..
_static Screenshots in 0.7 release notes 2014-10-08 16:42:54 +01:00
contrib Update docs for static site generation 2015-04-16 10:56:29 +01:00
editor_manual
getting_started Update docs to reflect the fact that django-libsass / Pillow are not being installed separately 2015-03-24 13:56:16 +00:00
howto Removed patterns() from docs 2015-04-10 16:57:05 +01:00
images Removed patterns() from docs 2015-04-10 16:57:05 +01:00
pages 0.9 => 1.0 2015-04-09 17:06:32 +01:00
reference Removed all versionadded older than 0.7 2015-04-09 17:03:33 +01:00
releases better heading 2015-04-09 14:13:11 +01:00
search Removed all versionchanged older than 0.7 2015-04-09 17:05:26 +01:00
Makefile
README.md
autobuild.sh
conf.py Revert "Versioning changes" 2015-02-18 12:56:29 +00:00
form_builder.rst Moved core components on level up 2015-03-23 17:39:18 +00:00
index.rst Renamed "For frontend developers" to "Writing templates" 2015-03-26 14:17:35 +00:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
snippets.rst Moved core components on level up 2015-03-23 17:39:18 +00:00
support.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.