wagtail/docs
Andy Babic 5e6a674686 Minor release notes amends 2020-09-04 11:04:38 +01:00
..
_static
advanced_topics Add notes for CORS settings on Google Cloud Storage 2020-08-24 13:05:38 +01:00
contributing
editor_manual
getting_started
reference Add RoutablePage.render() helper method and update documentation 2020-09-01 22:24:08 +01:00
releases Minor release notes amends 2020-09-04 11:04:38 +01:00
topics Update responsive embeds docs 2020-08-27 12:25:23 +01:00
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.