wagtail/docs
Karl Hobley cf38b2457d Put quotes around some inline code 2020-10-03 14:43:03 +01:00
..
_static
advanced_topics
contributing
editor_manual
getting_started
reference Put quotes around some inline code 2020-10-03 14:43:03 +01:00
releases Put quotes around some inline code 2020-10-03 14:43:03 +01:00
topics ElasticSearch => Elasticsearch 2020-10-03 14:43:03 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
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.