0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Rob Moorman c7b778c4e9 Removed docs
Added release docs with upgrade consideration of alternative to django-medusa
2017-03-23 12:30:21 +01:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Setting for your most recent edits (#3483) 2017-03-22 20:47:57 +01:00
contributing Add browser support targets in contributing guidelines 2017-02-20 20:46:40 +00:00
editor_manual Add note that promoted search results are an optional feature (#3343) 2017-02-21 10:57:25 +00:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference Removed docs 2017-03-23 12:30:21 +01:00
releases Removed docs 2017-03-23 12:30:21 +01:00
topics Document get_rendition() 2017-02-21 22:48:20 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
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.