0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2016-10-27 20:55:19 +01:00
..
_static/images Added documentation for editors to configure redirects 2016-08-25 11:18:55 +01:00
advanced_topics Update PageViewRestriction model to support group/login restriction type 2016-10-27 16:42:08 +03:00
contributing We don't have t-shirts any more :-( 2016-10-27 20:55:19 +01:00
editor_manual Fix documentation typo (#3042) 2016-10-03 09:04:39 +01:00
getting_started Bumped supported Django version to 1.10 2016-08-25 10:09:08 +01:00
reference Add Page.objects.first_common_ancestor() method 2016-10-26 13:01:46 +01:00
releases fixes issue where closing the 'MORE' action scrolls to the top of page. 2016-10-27 20:47:16 +01:00
topics Add PageChooserBlock target_model option 2016-10-26 13:01:46 +01:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
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 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 Added support for AWS CloudFront in Frontend cache invalidation module (#1845) 2016-08-29 15:15:27 +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.