wagtail/docs
Matt Westcott 307a1aab9e Release note for #7893 in 2.15.3 2022-01-26 11:27:31 +00:00
..
_static Images in PR #7872 were unfortunately swapped 2022-01-21 11:20:06 +00:00
_templates
advanced_topics Added a section to deployment docs about configuring serving of user uploaded files (#7553) 2022-01-21 11:21:53 +00:00
contributing Add missing backtick 2022-01-19 17:07:47 +00:00
editor_manual Added a section to deployment docs about configuring serving of user uploaded files (#7553) 2022-01-21 11:21:53 +00:00
extending Adding documentation for grouped custom menu items (#7872) 2022-01-21 10:03:35 +00:00
getting_started Formalise support for Django 4.0 2022-01-24 11:46:12 +00:00
reference hooks - update unnecessary format_html to mark_safe 2022-01-26 11:19:27 +00:00
releases Release note for #7893 in 2.15.3 2022-01-26 11:27:31 +00:00
topics Remove errant greater than 2022-01-20 23:42:33 +00: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.org 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.