wagtail/docs
Sander Tuit 4e7ccdcdc9 Add icon template tag with accessibility options (PoC) (#4381) 2018-04-08 23:41:24 +03:00
..
_static Fixes a Javascript month indexing. 2018-03-22 11:27:54 +01:00
advanced_topics Fix capitalisation of names 2018-04-05 12:13:05 +01:00
contributing
editor_manual Fix spelling mistakes in documentation 2018-04-05 12:13:05 +01:00
getting_started Fix capitalisation of QuerySet 2018-04-05 12:13:05 +01:00
reference another typo fix 2018-04-06 16:19:49 +01:00
releases Add icon template tag with accessibility options (PoC) (#4381) 2018-04-08 23:41:24 +03:00
topics Wording clarification 2018-04-06 16:23:04 +01:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
readthedocs.yml
requirements.txt
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst

README.md

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.