wagtail/docs
Karl Hobley 60e2d81052 Use search backend module imports in the docs 2015-07-01 14:36:50 +01:00
..
_static/images Added snippets section 2015-06-25 12:00:46 +01:00
advanced_topics Merge branch 'search-config-tweak' of https://github.com/kaedroho/wagtail into kaedroho-search-config-tweak 2015-06-26 16:33:21 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Remove "Documentation currently incomplete and in draft status" note from editor manual 2015-06-30 10:41:39 +01:00
getting_started Add basic blog template to tutorial. 2015-06-21 18:39:47 -04:00
reference Add `.specific()` page queryset method 2015-06-29 15:53:18 +01:00
releases release note for #1251 2015-06-29 16:59:31 +01:00
topics Use search backend module imports in the docs 2015-07-01 14:36:50 +01:00
Makefile
README.md minor docs readme change 2015-06-23 14:54:35 +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 added logo 2015-05-18 09:11:11 +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

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 -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.