wagtail/docs
PaarthAgarwal 520dfa8005 Ensure screen readers are made aware of page level messages
- when added dynamically to the top of the page
- already added to the authentication pages via #8925
2022-08-19 17:48:18 +10:00
..
_static
_templates
advanced_topics fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
contributing Fix dead Transifex links 2022-08-19 17:28:31 +10:00
editor_manual fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
extending Fix DocumentChooserBlock deconstruction for custom document models 2022-08-16 20:50:04 +01:00
getting_started fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
reference Ensure telepath adapter gets registered for document chooser widget 2022-08-17 18:24:18 +01:00
releases Ensure screen readers are made aware of page level messages 2022-08-19 17:48:18 +10:00
topics fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.md

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.