wagtail/docs
Matt Westcott f7fcae0a1d Release note for #6945 2021-10-15 01:16:33 +01:00
..
_static
_templates
advanced_topics add ability to customise the pre-filled Image title 2021-10-06 19:53:30 +10:00
contributing update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
editor_manual Document add, change, delete permissions when managing permissions 2021-10-15 00:26:37 +01:00
extending update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
getting_started Replace unneeded length filter 2021-10-14 13:25:03 +01:00
reference Updates to docs for new database search backend 2021-10-11 20:12:24 +01:00
releases Release note for #6945 2021-10-15 01:16:33 +01:00
topics Create new permission policy CollectionMangementPermissionPolicy 2021-10-15 00:44:05 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst Link to Github discussion boards 2021-09-30 19:00:18 +10:00

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.