wagtail/docs
jacobtoppm b10b24a7b6 Update descriptions of the editing interface and workflow management for consistency. Note that screenshots are not yet updated 2020-08-07 17:10:23 +01:00
..
_static
advanced_topics
contributing
editor_manual Update descriptions of the editing interface and workflow management for consistency. Note that screenshots are not yet updated 2020-08-07 17:10:23 +01:00
getting_started Formalise Django 3.1 support 2020-08-06 11:26:26 +01:00
reference Add hooks for snippet listing buttons 2020-08-07 15:47:27 +01:00
releases Release notes for #6267 and #6268 2020-08-07 15:51:09 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

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.