wagtail/docs
Matt Westcott 110101d96e Make Django 3.0 support official 2019-12-17 14:24:31 +00:00
..
_static
advanced_topics Update links in docs to point at stable Django version 2019-12-01 13:19:40 +10:00
contributing Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
editor_manual Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
getting_started Make Django 3.0 support official 2019-12-17 14:24:31 +00:00
reference Documentation - include {{ block.super }} example in modelAdmin 2019-12-02 09:43:33 +10:00
releases Make Django 3.0 support official 2019-12-17 14:24:31 +00:00
topics Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://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.