wagtail/docs
Matt Westcott 4caa860149 Mark 0.8, 1.4, 1.8 and 1.12 as LTS releases in release notes 2017-07-04 15:20:44 +01:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics Class based embed finders and new embed finder configuration (#2127) 2017-07-03 18:28:13 +01:00
contributing Pin isort to 4.2.5 - fixes #3623 2017-06-02 12:23:49 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Fix deprecated import of modelcluster.tags in tutorial 2017-06-19 12:23:30 +01:00
reference Define a 'before_serve_document' hook 2017-06-16 14:50:47 +01:00
releases Mark 0.8, 1.4, 1.8 and 1.12 as LTS releases in release notes 2017-07-04 15:20:44 +01:00
topics Put a space back 2017-07-04 09:58:01 +01: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.