wagtail/docs
Matt Westcott 7ff9f3ee50 Release note for #1147 2015-04-08 11:49:19 +01:00
..
_static
contrib "register" should be "reciever" 2015-04-01 17:14:20 +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 Remove mention of celery from docs 2015-03-31 10:29:58 +01:00
images Moved core components on level up 2015-03-23 17:39:18 +00:00
pages Merge pull request #1131 from negletios/documentation-fixes 2015-03-31 16:59:03 +01:00
reference release note for #1114 2015-03-30 12:41:01 +01:00
releases Release note for #1147 2015-04-08 11:49:19 +01:00
search Fixed import for pageurl tag which has moved from pageurl to wagtailcore_tags library 2015-03-29 16:22:33 +02: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.