wagtail/docs
Matt Westcott 3a9a2815c0 Release note for #7741 2022-01-07 16:11:45 +00:00
..
_static
_templates
advanced_topics
contributing
editor_manual
extending
getting_started
reference
releases
topics
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.