wagtail/docs
LB Johnston fda10b0211 add changelog for #8676 2022-06-16 06:45:12 +10:00
..
_static Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics Add guidance on rendition prefetching to docs (#8363) 2022-04-16 10:18:42 +00:00
contributing Add Wagtail 3 classifier to documentation 2022-05-08 19:28:29 +10:00
editor_manual documentation - migrate editor's guide to markdown from RST 2022-04-06 06:48:43 +10:00
extending Make nested list render as a nested list (#8516) 2022-05-11 09:05:59 +01:00
getting_started Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
reference API docs for Panel 2022-04-22 17:28:28 +01:00
releases add changelog for #8676 2022-06-16 06:45:12 +10:00
topics Add use_json_field=True to all StreamField examples (#8359) 2022-04-14 11:09:19 +01: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 Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01: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 Update myst_parser to v0.17.2 (#8380) 2022-05-16 14:38:48 +01: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:16:24 +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.