Historia

Bertrand Bordage 5f465276a1 window.history.pushState → replaceState. No longer floods the history.		2018-01-08 15:29:22 +01:00
..
_static	make font more readable	2018-01-06 11:00:08 +10:00
advanced_topics	Update documentation for rich text element whitelisting	2018-01-05 16:15:59 +00:00
contributing	Add line break to makemigrations code snippet	2017-11-27 01:11:09 +00:00
editor_manual	Renamed wagtail.contrib.wagtailsearchpromotions to	2017-11-26 22:43:47 +00:00
getting_started	add on_delete argument to ParentalKey & ForeignKey	2017-12-15 10:33:09 +00:00
reference	Use class based views instead of function views	2018-01-08 16:27:09 +10:00
releases	window.history.pushState → replaceState.	2018-01-08 15:29:22 +01:00
topics	Fix anchor syntax	2018-01-05 16:33:33 +00:00
Makefile	add way of autocompile documentation	2017-02-20 20:24:17 +00:00
README.md	…
autobuild.sh	[skip ci] added commment about autobuild inside vms (#3379 )	2017-02-16 21:29:10 +00:00
conf.py	add wagtail colours to docs sidebar	2018-01-05 14:51:05 +10:00
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	Remove references to Gondor.io in documentation.	2017-01-30 12:36:26 +00:00
support.rst	Mention Slack on support documentation	2017-11-15 21:06:45 +00: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.