0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 17:13:31 +01:00
wagtail/docs
2021-08-03 16:07:18 +01:00
..
_static Optimize images used in documentation 2021-07-06 21:14:33 +01:00
_templates
advanced_topics Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
contributing Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
editor_manual Update title of documentation page (#7368) 2021-07-27 09:19:07 +01:00
extending Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
getting_started Possessive "it" (#7357) 2021-07-21 16:25:48 +01:00
reference Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
releases Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
topics Fix "undefined label" warnings caused by missing leading underscore in the label 2021-07-21 15:05:19 +01:00
autobuild.sh
conf.py
favicon.ico
index.rst Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
logo.png
Makefile
README.md
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst Add background information on multi site, multi instance and multi tenancy (#7228) 2021-07-09 17:05:28 +01:00

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.