wagtail/docs
Thibaud Colas d97f940e58 Release notes for #5885 2020-07-23 13:56:12 +01:00
..
_static
advanced_topics Update third_party_tutorials.rst 2020-07-17 10:57:48 +01:00
contributing
editor_manual
getting_started Replace a few instances of re_path with path 2020-07-06 13:15:39 +01:00
reference Add warning about WAGTAILFORMS_HELP_TEXT_ALLOW_HTML 2020-07-20 10:36:41 +01:00
releases Release notes for #5885 2020-07-23 13:56:12 +01:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.io when the master 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.