wagtail/docs
Karl Hobley cd62c72dcc Changed API for setting/getting focal points
Previously, we used a property to do this. Heres the advantages of the
new way:
 - The old way felt a bit like it was pretending to be a database field
   when it wasn't. The new way makes it easier for the developer to
   understand that this is just a setter/getter for 4 fields and not a
   field itself.
 - Code looks nicer
 - Easier to override in subclasses
 - More like Django user model
2014-11-03 10:09:29 +00:00
..
_static
contrib_components Update frontendcache.rst 2014-10-30 16:25:15 +00:00
core_components Changed API for setting/getting focal points 2014-11-03 10:09:29 +00:00
editor_manual
getting_started
howto
reference
releases Update roadmap.rst 2014-10-31 19:34:36 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
requirements.txt
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.