wagtail/docs
Matt Westcott 53ab6741b5 Fill in release date for 2.13 2021-05-12 14:58:08 +01:00
..
_static
_templates
advanced_topics Add documentation for custom JS on StructBlocks () 2021-05-12 11:52:25 +01:00
contributing Update accessibility contribution guidance in bug report and PR templates () 2021-05-11 16:57:29 +01:00
editor_manual
getting_started
reference Fix usage of html syntax instead of html+django () 2021-05-05 11:08:40 +01:00
releases Fill in release date for 2.13 2021-05-12 14:58:08 +01:00
topics Fix usage of html syntax instead of html+django () 2021-05-05 11:08:40 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

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