0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 13:10:14 +01:00
wagtail/docs
2017-11-06 14:30:04 +00:00
..
_static/images Add 'The Zen of Wagtail' document 2017-09-27 12:20:34 +01:00
advanced_topics Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
contributing Remove Python 2 references from docs 2017-10-13 12:24:42 +01:00
editor_manual
getting_started Remove more Django 1.8 references from docs 2017-10-25 16:15:02 +01:00
reference Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
releases Release note for #3981 2017-11-06 14:30:04 +00:00
topics Remove ES 1.x search backend 2017-11-06 14:27:27 +00:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile
README.md
readthedocs.yml requirements_file not needed, but maybe pip_install is 2017-10-09 18:15:36 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +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.