0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2016-11-09 15:47:55 +00:00
..
_static/images remove as-yet-unused tutorial screenshots for categories 2016-11-09 15:47:55 +00:00
advanced_topics Update PageViewRestriction model to support group/login restriction type 2016-10-27 16:42:08 +03:00
contributing Tell developers to use the bundled version of six (we don't install it as a dependency any more) 2016-11-09 10:35:12 +00:00
editor_manual Fix documentation typo (#3042) 2016-10-03 09:04:39 +01:00
getting_started Remove categories section, add better example of MultiFieldPanel, minor copyediting 2016-11-09 14:35:58 +00:00
reference [FIX] Cloudfront docs typo (#3143) 2016-11-08 09:42:46 +00:00
releases Release note for #3035 2016-11-03 16:58:54 +00:00
topics Document the fact that a matching version of the elasticsearch package must be used 2016-11-04 11:14:12 +00:00
autobuild.sh
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01: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
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 Added support for AWS CloudFront in Frontend cache invalidation module (#1845) 2016-08-29 15:15:27 +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 -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.