wagtail/docs
Matt Westcott ef4aa3b54e Release note for #2031 2016-03-07 18:29:24 +00:00
..
_static/images
advanced_topics Remove dead link 2016-03-06 21:05:05 +00:00
contributing Fixes wrong links format in CSS coding guidelines 2016-03-07 20:38:47 +03:00
editor_manual
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 Release note for #2031 2016-03-07 18:29:24 +00:00
topics Fix internal links with anchors 2016-03-06 21:05:05 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

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.