0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Karl Hobley 5eef0f0a24 Mention that ImageMagick must be installed in "Animated GIF support"
Fixes #2505. Thanks to Frank Wiles and @ghostwords for spotting
2016-04-29 16:23:27 +01:00
..
_static/images Promote the redesigned userbar to a major feature 2016-03-08 15:48:24 +00:00
advanced_topics Mention that ImageMagick must be installed in "Animated GIF support" 2016-04-29 16:23:27 +01:00
contributing Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
reference Removed all uses of STATIC_URL from code samples, replaced with static(). 2016-04-28 10:57:22 +01:00
releases Release note for #2499 2016-04-28 16:24:08 +01:00
topics Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01: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
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00: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 -e .[testing,docs]

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.