0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Ben Sturmfels 5301010474 Update docs for Amazon ElasticSearch service as backend.
This change moves the "connection_class" key into "OPTIONS", resolving error
``AttributeError: 'AWS4Auth' object has no attribute 'encode'``.
2017-08-23 21:11:25 +01:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics Minor documentation example fix; bold and italic should be spelled out explicitly. (#3779) 2017-08-22 20:29:15 +03:00
contributing Mention the RFC process on the contributing page 2017-08-16 10:19:16 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Fix deprecated import of modelcluster.tags in tutorial 2017-06-19 12:23:30 +01:00
reference Remove old versionadded annotations from the docs 2017-08-22 14:08:44 +01:00
releases Updating to allow no limit max 2017-08-22 12:09:05 +01:00
topics Update docs for Amazon ElasticSearch service as backend. 2017-08-23 21:11:25 +01:00
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
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +01:00
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.