0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 03:31:04 +01:00
wagtail/docs
Matt Westcott e263aaf749 Update release schedule info and move dates table to the wiki
Document release schedule in readme
2019-08-23 13:15:24 -04:00
..
_static Release note for StreamField design update (#5476) 2019-08-23 15:53:48 +01:00
advanced_topics fix(docs/customization): Add models import to fix example (#5520) 2019-08-20 11:57:14 +01:00
contributing Clarify CHANGELOG instructions in "Committing code" docs (#5483) 2019-08-05 13:35:29 +01:00
editor_manual Add support for phone links in rich text 2019-08-01 16:12:22 +02:00
getting_started
reference Update docs with new locations of wagtail.admin.utils definitions 2019-08-19 18:58:56 +02:00
releases Update release schedule info and move dates table to the wiki 2019-08-23 13:15:24 -04:00
topics Upgrade minimum 6.x release for Elasticsearch to 6.4.0 2019-08-18 15:37:11 +10:00
autobuild.sh
conf.py
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.