wagtail/docs
Matt Westcott e0b4938c1d Renumber 4.0.3 to 4.0.4 in release notes 2022-10-18 13:24:53 +01:00
..
_static Update editor manual screenshots 2022-09-12 22:00:25 +10:00
_templates update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:13:24 +10:00
advanced_topics Fix code style of example in Wagtail API docs 2022-09-19 21:49:32 +10:00
contributing Fix note markup in developing doc 2022-09-22 15:11:00 +10:00
editor_manual Revert chooser button labels to "Choose another X" 2022-09-14 07:41:24 +10:00
extending Add changelog entry for 4.0 - bulk actions for snippets #8574 2022-09-19 19:59:09 +10:00
getting_started Add alternative text for all documentation screenshots 2022-09-12 22:00:25 +10:00
reference Ensure all panels output their own help_text (#9240) 2022-09-28 10:54:21 +01:00
releases Renumber 4.0.3 to 4.0.4 in release notes 2022-10-18 13:24:53 +01:00
topics Add links to topic guide from mixin reference docs 2022-08-21 07:20:30 +10:00
Makefile
README.md auto-format core markdown files (#8603) 2022-06-01 23:08:56 +10:00
autobuild.sh
conf.py replace latin abbreviations with english phrases & updated docs guidelines 2022-07-20 16:11:38 +10:00
favicon.ico
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
requirements.txt update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:13:24 +10:00
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt
support.md documentation - migrate docs/support to markdown 2022-06-28 16:16:09 +10:00

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.