0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Matt Westcott 749258ebbb Merge pull request #1828 from jheasly/patch-1
Docs fix: Need to flip order of class creation
2015-10-15 11:40:45 +01:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Reworded sentence about using "self" in templates 2015-10-13 09:55:23 +01:00
contributing Normalise all code blocks in the docs 2015-10-05 16:55:58 +01:00
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started Need to flip order of class creation 2015-10-14 17:29:19 -07:00
reference Remove mention of SASS / django-compressor; fix minor text errors 2015-10-15 09:21:47 +01:00
releases Release note for #1791 2015-10-14 17:26:03 +01:00
topics Merge branch 'docs-self-var' of https://github.com/kaedroho/wagtail into kaedroho-docs-self-var 2015-10-14 14:52:00 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py added logo 2015-05-18 09:11:11 +01:00
index.rst Renamed to "Page models" 2015-10-05 21:07:09 +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 Include Twitter account in support contacts. 2014-02-18 23:03:42 +00:00

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.