0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2015-05-14 15:27:14 +01:00
..
_static/images moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
contributing Fix reference to javascript_guidelines 2015-05-14 10:26:03 +01:00
editor_manual Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
getting_started Spelling corrections 2015-04-19 10:53:34 +01:00
howto Add Sites to configuration instructions 2015-04-25 12:22:54 -05:00
reference Rename docs for contrib modules 2015-05-14 15:27:14 +01:00
releases Changelog/release notes/contributors for #1176 2015-05-07 10:12:31 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Update docs copyright year 2015-04-25 13:01:58 -05:00
index.rst Fix formatting of docs front page 2015-05-14 14:17:59 +01:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 11:20:50 +01:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
spelling_wordlist.txt Spelling fixes for form builder 2015-05-14 11:11:58 +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 Wagatail's development requirements (in the root Wagtail directory):

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