0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2019-05-07 18:22:37 +01:00
..
_static Make the page reordering UI easier to find (#5187) 2019-03-29 14:38:05 +00:00
advanced_topics Update performance.rst 2019-05-01 12:58:22 +01:00
contributing Update accessibility-related docs to clarify tools usage and reflect feedback 2019-04-29 13:55:41 +01:00
editor_manual Fix small typos/grammar in documentation 2019-04-30 07:35:45 +10:00
getting_started Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
reference Add Django models import to Site Settings docs 2019-05-03 17:11:27 +01:00
releases Add release notes page for 2.5.1 2019-05-07 18:22:37 +01:00
topics Create reference in docs to PostgreSQL backend 2019-05-03 13:36:02 +01: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
README.md
requirements.txt
spelling_wordlist.txt
support.rst

Wagtail docs

These are Sphinx docs, automatically built at http://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.