0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 17:13:31 +01:00
wagtail/docs
2021-12-08 17:08:21 +00:00
..
_static
_templates
advanced_topics Documentation - remove all jQuery usage (#7658) 2021-12-07 15:37:33 +00:00
contributing
editor_manual Language tweaks 2021-11-16 09:59:36 +00:00
extending Documentation - remove all jQuery usage (#7658) 2021-12-07 15:37:33 +00:00
getting_started Formally deprecate old db search backends (#7651) 2021-10-28 10:53:32 +01:00
reference Documentation - remove all jQuery usage (#7658) 2021-12-07 15:37:33 +00:00
releases Release note for #7762 in 2.15.2 2021-12-08 17:08:21 +00:00
topics Formally deprecate old db search backends (#7651) 2021-10-28 10:53:32 +01: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.