0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2017-08-16 18:12:08 +02:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics Fix link to RFC 8 2017-08-16 10:19:16 +01:00
contributing Mention the RFC process on the contributing page 2017-08-16 10:19:16 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Fix deprecated import of modelcluster.tags in tutorial 2017-06-19 12:23:30 +01:00
reference Grammar nitpick ('By default' sounds more natural than 'Per default') 2017-08-11 09:58:44 +01:00
releases Adds release notes for #3726. 2017-08-16 18:12:08 +02:00
topics Add help_text to DecimalBlock and RegexBlock 2017-08-11 11:48:51 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +01:00
spelling_wordlist.txt
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.