0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2015-10-06 01:18:25 +13:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Removed broken link to non-existent vagrant install script 2015-09-23 14:51:43 -05:00
contributing Transferred vagrant-wagtail-develop repo to torchbox 2015-09-30 16:24:42 +01:00
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
reference added some basic signals docs 2015-10-06 01:18:25 +13:00
releases Release note for #1744 2015-09-30 17:16:48 +01:00
topics Merge pull request #1719 from nimasmi/custom-queryset-docs 2015-09-23 09:52:43 +01:00
autobuild.sh
conf.py added logo 2015-05-18 09:11:11 +01:00
index.rst Add the Wagtail tutorial to docs 2015-06-01 15:30:07 +01:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile
README.md minor docs readme change 2015-06-23 14:54:35 +01: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

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.