wagtail/docs
Matt Westcott 259c71a16b Add release note for performance improvements 2021-07-21 17:29:03 +01:00
..
_static Optimize images used in documentation 2021-07-06 21:14:33 +01:00
_templates
advanced_topics Add a log action for copy_for_translation operation (#7352) 2021-07-21 16:22:55 +01:00
contributing Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
editor_manual Change wording of docs and UI for page aliases 2021-07-13 10:51:46 +01:00
getting_started Possessive "it" (#7357) 2021-07-21 16:25:48 +01:00
reference Add server-side min_num and max_num validation for ListBlock 2021-07-14 13:14:15 +01:00
releases Add release note for performance improvements 2021-07-21 17:29:03 +01:00
topics Fix "undefined label" warnings caused by missing leading underscore in the label 2021-07-21 15:05:19 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst Add background information on multi site, multi instance and multi tenancy (#7228) 2021-07-09 17:05:28 +01: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.