wagtail/docs
Karl Hobley ecd8d22c04 Merge pull request #599 from gasman/fix/child_relations
Fix page copy and replace_text to pick up child relations that are defined on a superclass
2014-09-05 12:49:57 +01:00
..
_static added new screenshots, corrected some typos 2014-08-11 19:23:49 +01:00
contrib_components Update frontend_cache_purging.rst 2014-08-08 09:42:12 +01:00
core_components Merge pull request #535 from gasman/feature/menu-api 2014-09-05 11:28:43 +01:00
editor_manual added new screenshots, corrected some typos 2014-08-11 19:23:49 +01:00
howto Merge branch 'master' into multilingual-tutorial 2014-08-26 11:57:52 +01:00
reference Added reference section 2014-07-25 15:33:41 +01:00
releases Merge pull request #599 from gasman/fix/child_relations 2014-09-05 12:49:57 +01:00
Makefile First pass at Sphinx docs 2014-02-18 17:45:31 +00:00
README.md auto doc builder notes 2014-03-11 17:39:13 +00:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py prepare for 0.5 release 2014-08-01 17:01:42 +01:00
gettingstarted.rst fix documentation syntax errors / warnings 2014-07-04 21:57:58 +01:00
index.rst Changelog, readme, docs and release notes for Django 1.7 support 2014-08-27 16:08:10 +01:00
requirements.txt Added requirements file for docs 2014-07-15 12:39:42 +01:00
support.rst Include Twitter account in support contacts. 2014-02-18 23:03:42 +00: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.