0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2015-12-24 11:57:53 +00:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Add docs for WagtailPageTests 2015-12-15 15:49:40 +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 Add pointers to the new integrating-with-Django docs 2015-11-10 21:45:21 +00:00
reference Use Django 1.8 TEMPLATES setting in settings doc 2015-12-16 09:29:17 +00:00
releases Changelog/release note for #2069 2015-12-24 11:57:53 +00:00
topics Set request.is_preview flag to show whether page is served as preview 2015-12-16 11:28:53 +00:00
autobuild.sh
conf.py Call django.setup() before making docs 2015-12-09 11:40:35 +00:00
index.rst Renamed to "Page models" 2015-10-05 21:07:09 +01:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile
README.md Removed backticks from readme 2015-10-23 22:04:56 +02:00
requirements.txt
spelling_wordlist.txt
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.