wagtail/docs
Dave Cranwell ef4d9b00c5 moved github issues/pr info into index page, leaving the developing page more about actual development, not housekeeping 2015-05-18 09:46:38 +01:00
..
_static/images moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
contributing moved github issues/pr info into index page, leaving the developing page more about actual development, not housekeeping 2015-05-18 09:46:38 +01:00
editor_manual Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
getting_started moved styleguide to own page. renamed trying wagtail to demo site 2015-05-18 09:46:38 +01:00
howto fixed couple of mislink reports 2015-05-18 09:13:02 +01:00
reference Change titles to links on contrib index 2015-05-14 16:01:03 +01:00
releases fixed couple of mislink reports 2015-05-18 09:13:02 +01:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py added logo 2015-05-18 09:11:11 +01:00
index.rst moved styleguide to own page. renamed trying wagtail to demo site 2015-05-18 09:46:38 +01:00
logo.png added logo 2015-05-18 09:11:11 +01:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
spelling_wordlist.txt Merge pull request #1304 from kaedroho/howto-spell-fixes 2015-05-14 17:05:48 +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 Wagatail's development requirements (in the root Wagtail directory):

pip install requirements-dev.txt

To build the documentation for browsing, from this directory run:

``make html`` 

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

``sphinx-autobuild . _build``

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.