wagtail/docs
Matt Westcott 119d2334ac Replace insert_editor_js hook example with a non-registerHalloPlugin one
Fixes #3839
2017-10-10 11:51:45 +01:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Remove Wagtail-1.4-era fallback for rest_framework not being installed 2017-10-10 11:51:45 +01: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:48:03 +01:00
reference Replace insert_editor_js hook example with a non-registerHalloPlugin one 2017-10-10 11:51:45 +01:00
releases Version bump to begin work on 2.0 2017-10-09 18:34:43 +01:00
topics Change StreamField examples to use explicit required=False instead of required=True 2017-09-18 21:34:35 +01:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt
support.rst

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.