0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2022-01-07 16:37:21 +00:00
..
_static Add line in editor guide about secondary actions menu and update screenshot 2022-01-07 16:23:17 +00:00
_templates
advanced_topics Document the bound_blocks property of ListValue 2022-01-07 16:11:45 +00:00
contributing
editor_manual Add line in editor guide about secondary actions menu and update screenshot 2022-01-07 16:23:17 +00:00
extending
getting_started
reference Add register_page_header_buttons hook documentation 2022-01-07 16:23:17 +00:00
releases Release note for #7783 2022-01-07 16:37:21 +00:00
topics
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.