mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00

History

mr-winter c185e57347 output sass errors in terminal and prevent gulp watch from exiting		2016-03-03 10:07:45 +00:00
..
_static/images	added clarification about template tags to tutorial	2015-10-05 22:01:03 +13:00
advanced_topics	Fix custom image docs to indicate that fields must be non-required	2016-03-01 12:07:35 +00:00
contributing	Add docs on committing code	2016-03-03 02:00:37 +02:00
editor_manual	Correcting typo int The Dashboard doc	2016-02-16 15:51:57 -05:00
getting_started	Removed django-compressor	2016-02-03 16:16:11 +00:00
reference	Add get_site and get_url_parts to the Page model reference docs	2016-03-01 12:11:14 +00:00
releases	output sass errors in terminal and prevent gulp watch from exiting	2016-03-03 10:07:45 +00:00
topics	fixed font size rounding issue in firefox, added contrib notes	2016-03-03 12:29:28 +13:00
autobuild.sh
conf.py	Call `django.setup()` before making docs	2015-12-09 11:40:35 +00: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
README.md	Eliminate reference to requirements-dev.txt	2016-02-05 15:48:01 +00:00
requirements.txt
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.