0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2015-08-21 18:19:04 +02:00
..
_static/images added promoted search page 2015-07-07 11:31:12 +01:00
advanced_topics 'extremely basic information' -> 'the hostname of your Wagtail site' 2015-07-15 17:12:19 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Add missing verb in editor manual 2015-08-21 18:19:04 +02:00
getting_started de-capitalise 'Body field' 2015-07-07 16:12:43 +01:00
reference Renamed searchpicks app to searchpromotions 2015-07-21 13:37:42 +01:00
releases Release note for #1492 2015-08-01 11:22:59 +02:00
topics Release note for #1490 2015-08-01 11:13:46 +02: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 Added spellcheker 2015-04-17 22:49:16 +01:00
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.