wagtail/docs
Loic Teixeira 9da3a3d975 Update documentation 2019-03-06 11:00:30 +00:00
..
_static Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
advanced_topics Fix typo in api/v2/usage.rst 2019-03-06 01:19:07 +00:00
contributing First positional argument for tox as test module/case path 2018-10-30 12:16:45 +00:00
editor_manual Update links to Draftail documentation 2019-02-14 23:24:30 +01:00
getting_started Add MEDIA_* settings to Django integration page (#5046) 2019-01-31 12:19:42 +00:00
reference Add 'wagtail_update_index' as an alias for the 'update_index' command (#5009) 2019-03-01 11:01:41 +00:00
releases Set data-focal-point-* values to be '' instead of 'None' when they are empty. 2019-03-03 10:06:16 +10:00
topics Update documentation 2019-03-06 11:00:30 +00:00
Makefile
README.md
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
favicon.ico
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
logo.png
requirements.txt
spelling_wordlist.txt
support.rst Add note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at http://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.