wagtail/docs
Charlie Choiniere ae2006ccf1 Moved all dev dependencies into setup.py
* Removed requirements-dev.txt
 * Added dependencies to setup.py using the extras_require option
 * Updated the documentation to use pip instead of setup.py develop
 * Updated .drone.yml to reflect updated installation
2016-02-05 14:44:51 +00:00
..
_static/images added clarification about template tags to tutorial 2015-10-05 22:01:03 +13:00
advanced_topics Remove django-compressor references from the 'Configuring Django' docs 2016-02-04 15:31:03 +00:00
contributing Moved all dev dependencies into setup.py 2016-02-05 14:44:51 +00:00
editor_manual Merge pull request #1635 from benebun/benebun-patch-editor_manual 2015-08-24 09:14:24 +01:00
getting_started Removed django-compressor 2016-02-03 16:16:11 +00:00
reference Fix parameter name on signal handler 2016-02-04 22:22:12 +00:00
releases release note for #2132 2016-02-04 17:35:59 +00:00
topics Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Removed backticks from readme 2015-10-23 22:04:56 +02:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Call `django.setup()` before making docs 2015-12-09 11:40:35 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +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

README.md

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.