wagtail/docs
Matt Westcott 1d8f85c1c5 Add upgrade considerations note for rename of API endpoint classes 2019-11-28 11:21:18 +00:00
..
_static
advanced_topics Rename `endpoints` modules to `views` 2019-11-28 09:00:56 +00:00
contributing Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
editor_manual Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
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 Add upgrade considerations note for rename of API endpoint classes 2019-11-28 11:21:18 +00:00
topics Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
spelling_wordlist.txt
support.rst Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

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.