wagtail/docs
Gordon Pendleton a64eb1f2f3 adjusted queries to ignore expired embeds (#7279) 2021-06-25 14:10:00 +01:00
..
_static
_templates
advanced_topics incorrect field name 2021-06-22 14:34:16 +01:00
contributing Update JavaScript guidelines to say two space indent 2021-05-17 15:26:10 +01:00
editor_manual
getting_started
reference Add titlesonly to reference / topics top-level TOCs 2021-06-18 15:17:24 +01:00
releases adjusted queries to ignore expired embeds (#7279) 2021-06-25 14:10:00 +01:00
topics Add titlesonly to reference / topics top-level TOCs 2021-06-18 15:17:24 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst

README.md

Wagtail docs

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