Historia

Tom Dyson 4e7b9bfd98 Merge pull request #1019 from zerolab/remove-build-dependencies Remove build dependencies. Fixes #985 and #958		2015-02-23 11:20:29 +00:00
..
_static	Screenshots in 0.7 release notes	2014-10-08 16:42:54 +01:00
contrib_components	Update static_site_generation.rst	2015-02-19 23:46:52 +00:00
core_components	Removed incomplete sections	2015-02-20 11:41:32 +00:00
editor_manual	Additions to the 'getting started' documentation so that we're not under-selling the demo site as a way to get started	2014-09-15 18:06:09 +01:00
getting_started	Separate dependencies in two subsections	2015-02-23 11:13:37 +00:00
howto	Update third_party_tutorials.rst	2015-02-18 00:29:24 +01:00
reference	Update page.rst	2015-02-21 10:05:41 +00:00
releases	Add changelog/release notes for #935/#1013	2015-02-23 10:01:38 +00:00
Makefile	…
README.md	…
autobuild.sh	…
conf.py	Revert "Versioning changes"	2015-02-18 12:56:29 +00:00
index.rst	Minor docs cleanup	2015-02-22 11:29:24 +00:00
requirements.txt	upgrade django-modelcluster to 0.5	2015-02-03 11:11:42 +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.