wagtail/docs
Karl Hobley 78a11e98f8 Add docs for custom image models 2015-05-18 10:19:32 +01:00
..
_static/images
contributing replaced bullets with headings in python guidelines 2015-05-18 09:46:38 +01:00
editor_manual
getting_started wording change 2015-05-18 09:46:38 +01:00
howto
reference Add docs for custom image models 2015-05-18 10:19:32 +01:00
releases
Makefile
README.md
autobuild.sh
conf.py
index.rst moved styleguide to own page. renamed trying wagtail to demo site 2015-05-18 09:46:38 +01:00
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 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.