wagtail/docs
Matt Westcott 62b9c42d3d Release note for #7944 in 2.16.1 2022-02-10 15:43:35 +00:00
..
_static Images in PR #7872 were unfortunately swapped 2022-01-21 11:20:06 +00:00
_templates Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
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 Update security PGP key to use new wagtail.org domain 2022-01-28 12:17:38 +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 Update email addresses for new .org domain (#7845) 2022-01-28 12:17:38 +00:00
getting_started Formalise support for Django 4.0 2022-01-24 11:46:28 +00:00
reference Documentation for #7827 2022-01-21 12:53:37 +00:00
releases Release note for #7944 in 2.16.1 2022-02-10 15:43:35 +00:00
topics Remove errant greater than 2022-01-20 23:42:33 +00:00
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
autobuild.sh
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
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 Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Update email addresses for new .org domain (#7845) 2022-01-28 12:17:38 +00: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.