wagtail/docs
Karl Hobley ad3737e7d7 Merge pull request #304 from jeffrey-hearn/docs-wagtail-app-config
Docs: Wagtail settings variables and urlconfs
2014-06-27 10:54:07 +01:00
..
_static/css
building_your_site Merge pull request #304 from jeffrey-hearn/docs-wagtail-app-config 2014-06-27 10:54:07 +01:00
editor_manual Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
images Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
Makefile
README.md
advanced_topics.rst
autobuild.sh
conf.py
contributing.rst wagtail -> Wagtail in contributing.rst 2014-06-18 17:17:14 +01:00
deploying.rst
editing_api.rst Merge pull request #304 from jeffrey-hearn/docs-wagtail-app-config 2014-06-27 10:54:07 +01:00
form_builder.rst Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
gettingstarted.rst Doc fix - use https rather than ssh for wagtaildemo clone 2014-06-16 09:39:06 +01:00
index.rst Added wagtail and django settings doc 2014-06-08 16:59:46 -04:00
model_recipes.rst Edit API docs expanded with hooks, modelcluster, and InlinePanel usage 2014-06-03 23:09:27 -04:00
performance.rst
roadmap.rst
settings.rst Settings doc changes based on feedback 2014-06-09 11:47:12 -04:00
snippets.rst
static_site_generation.rst
support.rst
wagtail_search.rst Merge pull request #304 from jeffrey-hearn/docs-wagtail-app-config 2014-06-27 10:54:07 +01:00

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.