wagtail/docs
Mikalai Radchuk 660278d417 Fixes typos in docs for #2201 and #2302 2016-03-07 09:47:40 +00:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Remove dead link 2016-03-06 21:05:05 +00:00
contributing Fixes typos in docs for #2201 and #2302 2016-03-07 09:47:40 +00:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Fix internal links with anchors 2016-03-06 21:05:05 +00:00
reference Fix internal links 2016-03-06 21:05:05 +00:00
releases Fixes release notes for #2253 2016-03-04 15:07:00 +03:00
topics Fix internal links with anchors 2016-03-06 21:05:05 +00:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Call `django.setup()` before making docs 2015-12-09 11:40:35 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
requirements.txt Build documentation with Django 1.8 fixes #1451 2015-06-29 09:11:21 +01:00
spelling_wordlist.txt Spellchecked editing api docs 2015-05-18 10:44:07 +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 Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

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.