0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 08:48:04 +01:00
wagtail/docs
2015-10-07 20:02:19 +01:00
..
_static/images
advanced_topics Merge pull request #1755 from takeflight/feature/jinja2-template-functions 2015-10-06 22:00:47 +01:00
contributing
editor_manual
getting_started
reference Minor copyediting on the Pages docs 2015-10-05 21:07:09 +01:00
releases Release note for #1755 2015-10-06 22:21:25 +01:00
topics Document the new image/document queryset search method 2015-10-07 20:02:19 +01:00
autobuild.sh
conf.py
index.rst Renamed to "Page models" 2015-10-05 21:07:09 +01:00
logo.png
Makefile
README.md
requirements.txt
spelling_wordlist.txt
support.rst

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 -r 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.