0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2016-03-11 17:21:53 +00:00
..
_static/images Promote the redesigned userbar to a major feature 2016-03-08 15:48:24 +00:00
advanced_topics Various typo fixes and grammar/clarity improvements. 2016-03-10 15:11:41 +00:00
contributing Recommend the -U switch when running pip install -e . 2016-03-07 18:31:29 +00:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Fix internal links with anchors 2016-03-06 21:05:05 +00:00
reference CamelCase JavaScript in hooks documentation 2016-03-11 17:19:45 +00:00
releases Release note for #2333 2016-03-11 17:21:53 +00:00
topics Searchly no longer supports Elasticsearch 1.x, so I switched the suggested development service to Bonsai. 2016-03-10 15:11:42 +00:00
autobuild.sh
conf.py Call django.setup() before making docs 2015-12-09 11:40:35 +00:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png
Makefile
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
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.