wagtail/docs
Thibaud Colas 4285b9f1cc Add start of example for entity docs 2018-02-09 15:24:24 +00:00
..
_static Add start of example for entity docs 2018-02-09 15:24:24 +00:00
advanced_topics Add start of example for entity docs 2018-02-09 15:24:24 +00:00
contributing
editor_manual Clean up editor guide section still referring to Hallo screenshots 2018-02-09 15:24:24 +00:00
getting_started Add on_delete to BlogPageTag model 2018-02-08 11:52:45 +00:00
reference Fix modeladmin documentation typo (#4251) 2018-02-08 10:53:36 +00:00
releases Add missing release notes and dependencies as globals docs from Draftail work 2018-02-09 15:24:24 +00:00
topics Used Python 3 super() syntax also in documentation. (#4246) 2018-02-07 10:11:27 +00:00
Makefile
README.md
autobuild.sh
conf.py
index.rst
logo.png
readthedocs.yml
requirements.txt
spelling_wordlist.txt
support.rst

README.md

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.