0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2017-02-08 22:21:35 +00:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Updated docs to use a list for urlpatterns 2017-02-05 19:59:39 +00:00
contributing Removing errant words in sample path/to/wagtail 2017-02-03 20:41:08 +00:00
editor_manual Add browser issues/support section for editors 2017-02-08 22:21:35 +00:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference in Page reference docs, don't tell people to consult source code (#3303) 2017-01-28 00:11:52 +00:00
releases Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
topics Document wagtailsearch settings for Amazon Elasticsearch Service (#3345) 2017-02-08 18:58:24 +00:00
autobuild.sh
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst
logo.png
Makefile
README.md
requirements.txt
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +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.