wagtail/docs
2018-08-13 14:33:32 +01:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Fix syntax error in ImageRenditionField example 2017-11-12 18:10:13 +00:00
contributing Fix link to stylelint site in documentation 2017-08-26 19:07:08 +03:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Say "as a child of Homepage" rather than "under Homepage", to avoid ambiguity 2017-10-10 11:58:26 +01:00
reference Release note for #3824 2017-10-05 15:40:55 +01:00
releases Release notes for 1.13.4 2018-08-13 14:33:32 +01:00
topics Update warning re ATOMIC_REBUILD on Elasticsearch >= 5.4 2017-11-03 15:55:49 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
readthedocs.yml see if requirements_file: null makes readthedocs happy 2018-08-10 16:31:55 +01:00
requirements.txt Tell readthedocs to use python 3 2017-10-10 11:58:25 +01:00
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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.