0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2020-02-26 14:11:17 +00:00
..
_static Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
advanced_topics Update wording 2020-02-17 12:06:19 +00:00
contributing Mention docker-wagtail-develop in developing docs (#5820) 2020-02-12 14:11:40 +01:00
editor_manual Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
getting_started Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00:00
reference Documentation for custom tag models 2020-02-26 14:10:21 +00:00
releases Release note for #5848 2020-02-26 14:11:17 +00:00
topics Remove remaining references to request.site 2020-02-17 12:06:19 +00:00
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
favicon.ico
index.rst
logo.png
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
requirements.txt
spelling_wordlist.txt
support.rst Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

Wagtail docs

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