wagtail/docs
jacobtoppm 7907aff7ff Use CSS variables for comment highlight colours 2021-04-20 18:25:30 +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 Use CSS variables for comment highlight colours 2021-04-20 18:25:30 +01:00
contributing Fix documentation build warnings 2021-04-15 17:17:11 +01:00
editor_manual
getting_started Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
reference Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
releases Add release note about reporting theme issues 2021-04-20 12:31:26 +02:00
topics Use resolve_url() instead of reverse() for pageurl fallbacks (#7002) 2021-04-14 15:26:11 +01:00
Makefile
README.md
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
requirements.txt Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
robots.txt
spelling_wordlist.txt
support.rst

README.md

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.