0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Matt Westcott 4353759018 Merge branch 'kaedroho-snippets-search'
Conflicts:
	CHANGELOG.txt
2015-08-27 15:42:45 +01:00
..
_static/images added promoted search page 2015-07-07 11:31:12 +01:00
advanced_topics Tweaks based on feedback from @tomdyson 2015-08-24 12:09:47 +01:00
contributing Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started Fix typo templage > template 2015-08-03 15:35:32 +02:00
reference Documentation for #1621 2015-08-25 16:15:31 +01:00
releases Merge branch 'kaedroho-snippets-search' 2015-08-27 15:42:45 +01:00
topics Merge branch 'kaedroho-snippets-search' 2015-08-27 15:42:45 +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 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.