0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2016-01-22 11:24:41 +00:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Reorder INSTALLED_APPS to put most specific apps first 2016-01-21 10:18:48 +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 Document setting up MEDIA_ROOT in the Django integration docs 2016-01-12 15:40:35 +00:00
reference Fix Page model recipes to pass 'self' as the page object ('page' is undefined) 2016-01-22 11:24:41 +00:00
releases Clarify what the Administrator flag does 2016-01-21 12:48:34 +00:00
topics Remove Django 1.7 support from documentation, requirements and CI definitions 2016-01-05 17:38:29 +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
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.