wagtail/docs
John Franey 79e6951d95 Update form_builder.rst
These old tag libraries have been replaced by ```wagtailcore_tags``` according to (http://wagtail.readthedocs.org/en/latest/core_components/pages/writing_templates.html?highlight=pageurl#internal-links-tag)[here] and (http://wagtail.readthedocs.org/en/latest/core_components/pages/writing_templates.html?highlight=rich_text#rich-text-filter)[here].
2015-01-17 00:42:58 -05:00
..
_static Screenshots in 0.7 release notes 2014-10-08 16:42:54 +01:00
contrib_components Update frontendcache.rst 2014-10-30 16:25:15 +00:00
core_components Update form_builder.rst 2015-01-17 00:42:58 -05: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 ubuntu.sh & debian.sh missing from https://wagtail.io/ 2014-10-13 11:05:01 -04:00
howto Use AppConfig.ready to register signal handlers 2014-10-14 09:33:19 +11:00
reference fix warning about code-block directive 2014-10-08 10:57:10 +01:00
releases Changelog/release notes for #854 2015-01-15 13:59:54 +00: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 Made docs look at wagtailcore.__version__ 2014-09-09 12:56:26 +01:00
index.rst Removed support for Django 1.6 and Python 2.6 2015-01-02 17:27:54 +00:00
requirements.txt Unpinned some requirements 2014-12-03 09:25:37 +00: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.