wagtail/docs
Martin Sandström c0a84975e7 Add ability to export redirects using reports (#6305) 2021-04-15 16:37:05 +01:00
..
_static
_templates
advanced_topics Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
contributing Update links to Diátaxis framework 2021-04-12 14:34:04 +01:00
editor_manual
getting_started
reference Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
releases Add ability to export redirects using reports (#6305) 2021-04-15 16:37:05 +01: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
favicon.ico
index.rst
logo.png
requirements.txt
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.