wagtail/docs
Eugene Morozov 7b55c5094f Backslash is not necessary when multi-line expression is parenthesized. 2017-07-18 09:56:42 +03:00
..
_static/images
advanced_topics Class based embed finders and new embed finder configuration (#2127) 2017-07-03 18:28:13 +01:00
contributing
editor_manual
getting_started
reference Backslash is not necessary when multi-line expression is parenthesized. 2017-07-18 09:56:42 +03:00
releases Hide wagtail icon from printed page representation. 2017-07-14 11:49:52 +02: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.