0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2021-04-20 20:28:33 +01:00
..
_static Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
advanced_topics Docs for customising account settings 2021-04-20 18:43:22 +01:00
contributing Fix documentation build warnings 2021-04-15 17:17:11 +01:00
editor_manual Duplicate block - editor docs 2021-03-17 23:32:57 +00:00
getting_started Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
reference Docs for customising account settings 2021-04-20 18:43:22 +01:00
releases Finalise release notes for 2.13rc1 2021-04-20 20:28:33 +01:00
topics Use resolve_url() instead of reverse() for pageurl fallbacks (#7002) 2021-04-14 15:26:11 +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 Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +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 documentation for reporting security issues 2020-04-20 11:57:26 +10: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.