0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2021-10-14 17:14:14 +01:00
..
_static
_templates
advanced_topics add ability to customise the pre-filled Image title 2021-10-06 19:53:30 +10:00
contributing
editor_manual
extending
getting_started Replace unneeded length filter 2021-10-14 13:25:03 +01:00
reference Updates to docs for new database search backend 2021-10-11 20:12:24 +01:00
releases Fill in release date for 2.14.2 2021-10-14 17:14:14 +01:00
topics Expose preview mode to page and template rendering 2021-10-14 06:47:26 +10:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile
README.md
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst

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.