wagtail/docs
Karl Hobley 16d5b5c99e Rename Endpoints to ViewSets
For consistency with Django REST Framework
2019-11-28 09:00:35 +00:00
..
_static
advanced_topics Rename Endpoints to ViewSets 2019-11-28 09:00:35 +00:00
contributing
editor_manual
getting_started Update link to settings reference doc 2019-11-20 17:54:43 +00:00
reference Move settings reference into separate doc 2019-11-20 17:39:46 +00:00
releases Changelog/release note for 2019-11-26 15:50:44 +00:00
topics
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://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.