0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2015-07-07 11:31:12 +01:00
..
_static/images added promoted search page 2015-07-07 11:31:12 +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
editor_manual added promoted search page 2015-07-07 11:31:12 +01:00
getting_started Add basic blog template to tutorial. 2015-06-21 18:39:47 -04:00
reference modelcluster.tags => modelcluster.contrib.taggit 2015-07-06 09:29: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
autobuild.sh
conf.py
index.rst
logo.png
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
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.