wagtail/docs
Matt Westcott 15095f589d Release note for #7726 in 2.15.2 2022-01-10 19:41:26 +00:00
..
_static
_templates
advanced_topics
contributing
editor_manual
extending Label edit actions as 'Edited' instead of 'Draft saved' for non Page models 2021-10-26 07:54:50 +10:00
getting_started Formally deprecate old db search backends (#7651) 2021-10-28 10:53:41 +01:00
reference Formally deprecate old db search backends (#7651) 2021-10-28 10:53:41 +01:00
releases Release note for #7726 in 2.15.2 2022-01-10 19:41:26 +00:00
topics Formally deprecate old db search backends (#7651) 2021-10-28 10:53:41 +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.