wagtail/docs
Janneke Janssen 493a30bcf9 Add nvmrc to the project and updated developing docs 2017-02-20 11:14:33 +01:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Fix unexpected full stop in the middle. Of a sentence. 2017-02-16 17:11:37 +00:00
contributing Add nvmrc to the project and updated developing docs 2017-02-20 11:14:33 +01:00
editor_manual Add browser issues/support section for editors 2017-02-08 22:21:35 +00:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference feat: Added `construct_image_chooser_queryset`, `construct_document_chooser_queryset` and `construct_page_chooser_queryset` hooks 2017-02-17 10:40:03 +00:00
releases Add nvmrc to the project and updated developing docs 2017-02-20 11:14:33 +01:00
topics Enhancement for PageChooserBlock 2017-02-17 11:30:32 +00:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py
index.rst
logo.png
requirements.txt
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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.