wagtail/docs
Sebastian 49d706b406 Update docs - run python manage.py migrate once
We have to run python manage.py migrate once, in order to create the necessary tables for the postgres search backend.
Otherwise we get an error, as the insert in the table is not possible.
2017-04-21 09:16:44 +01:00
..
_static/images Add image for m2m feature in release notes 2017-02-06 12:07:32 +00:00
advanced_topics Doc typos. 2017-04-19 18:38:17 +02:00
contributing Document pep8 issues to ignore (#3503) 2017-03-25 15:10:12 +01:00
editor_manual Added remove focalpoint button 2017-03-26 13:27:35 +02:00
getting_started Update docs to mention Django 1.11 / Python 3.6 support 2017-04-20 10:57:22 +01:00
reference Update docs - run python manage.py migrate once 2017-04-21 09:16:44 +01:00
releases Release note for #3046 2017-04-20 16:58:05 +01:00
topics Adds PostgreSQL search backend. (#3515) 2017-04-12 16:16:16 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +01:00
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

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.