0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2016-01-28 13:03:27 +00:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Allow specifying custom edit handlers for snippets 2016-01-28 13:03:27 +00:00
contributing Merge pull request #1914 from kaedroho/runtests-args 2015-11-30 12:26:16 +00:00
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
reference WAGTAILAPI_MAX_RESULTS is actually called WAGTAILAPI_LIMIT_MAX 2016-01-27 11:21:06 +00:00
releases Allow specifying custom edit handlers for snippets 2016-01-28 13:03:27 +00:00
topics Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
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 Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Removed backticks from readme 2015-10-23 22:04:56 +02:00
requirements.txt Build documentation with Django 1.8 fixes #1451 2015-06-29 09:11:21 +01:00
spelling_wordlist.txt Spellchecked editing api docs 2015-05-18 10:44:07 +01:00
support.rst Include Twitter account in support contacts. 2014-02-18 23:03:42 +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 -r requirements-dev.txt

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.