0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2021-07-14 13:14:15 +01:00
..
_static Optimize images used in documentation 2021-07-06 21:14:33 +01:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
advanced_topics Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +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 Drop support for Django 2.2 2021-04-30 10:33:41 +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 section for 2.15 2021-07-13 17:10:47 +01:00
topics Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
autobuild.sh
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico
index.rst Replace Divio with Gitpod 2021-04-20 17:19:33 +01:00
logo.png
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Change master to main (#6830) 2021-03-03 13:33:19 -05:00
requirements.txt Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
robots.txt Reinstate spidering of other documentation versions besides stable 2021-02-02 15:15:43 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Add background information on multi site, multi instance and multi tenancy (#7228) 2021-07-09 17:05:28 +01:00

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.