wagtail/docs
LB b2e139bbd3 update changelog/releases for #4535 2018-06-10 12:52:10 +10:00
..
_static
advanced_topics Add full documentation for WAGTAILADMIN_RICH_TEXT_EDITORS. Fixes #4555 2018-06-10 12:45:48 +10:00
contributing
editor_manual
getting_started updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 2018-05-18 14:43:42 +01:00
reference Reference the `get_url` method in Page model reference docs 2018-05-18 15:26:06 +01:00
releases update changelog/releases for #4535 2018-06-10 12:52:10 +10:00
topics updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 2018-05-18 14:43:42 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
readthedocs.yml
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.