0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00
wagtail/docs
2018-02-05 13:58:48 +00:00
..
_static make font more readable 2018-01-06 11:00:08 +10:00
advanced_topics Release notes and documentation for Draftail (#4136) 2018-01-25 16:38:38 +00:00
contributing Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
editor_manual Documentation edits 2018-01-15 22:58:00 +00:00
getting_started use https://docs.djangoproject.com/en/1.11... (#4204) 2018-01-29 18:51:59 +00:00
reference Documentation edits 2018-01-15 22:58:00 +00:00
releases binary string => byte string 2018-02-05 13:58:48 +00:00
topics Fix anchor syntax 2018-01-05 16:33:33 +00:00
autobuild.sh
conf.py add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
index.rst
logo.png
Makefile
README.md
readthedocs.yml
requirements.txt
spelling_wordlist.txt
support.rst Mention Slack on support documentation 2017-11-15 21:06:45 +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.