0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2016-12-09 15:30:46 +00:00
..
_static/images Image / updated writeup for page privacy feature in 1.8 2016-12-09 15:30:46 +00:00
advanced_topics Switch to Rendition.filter_spec as the active field for looking up filters 2016-12-06 15:03:15 +00:00
contributing Fix whitespace errors in docs 2016-11-28 13:41:35 +00:00
editor_manual Fix whitespace errors in docs 2016-11-28 13:41:35 +00:00
getting_started Clarify '# ...' comments when omitting code in tutorial snippets 2016-12-01 13:43:19 +00:00
reference Add note that wagtailforms is not a replacement for Django forms (#3190) 2016-12-05 18:19:59 +00:00
releases Image / updated writeup for page privacy feature in 1.8 2016-12-09 15:30:46 +00:00
topics Extra ES params passed through new OPTIONS key 2016-12-01 12:04:14 +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.