wagtail/docs
Matt Westcott 8b1699437f Release notes for 2.9.2 2020-07-03 12:58:19 +01:00
..
_static Tweak Wagtail logo hover animation in docs 2020-06-02 20:34:20 +10:00
advanced_topics
contributing
editor_manual
getting_started
reference Add more detail to RoutablePageMixin example (#6128) 2020-06-25 16:57:58 +01:00
releases Release notes for 2.9.2 2020-07-03 12:58:19 +01:00
topics Changelog/release note/contributor for #6040 2020-06-09 09:42:48 +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.