0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2016-06-17 15:51:39 +01:00
..
_static/images promote rich text link handling to a major feature 2016-05-19 17:01:17 +01:00
advanced_topics Documented the settings variable for WAGTAIL_USAGE_COUNT_ENABLED (#2706) 2016-06-13 20:47:27 +01:00
contributing Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started add note about Wagtail <=1.4 syntax for search_fields 2016-05-02 18:42:21 +01:00
reference mention edit_handler in this context (#2716) 2016-06-15 13:54:54 +01:00
releases Changelog/release note for #2715 2016-06-17 15:51:39 +01:00
topics Use python_2_unicode_compatible in snippets.rst (#2688) 2016-06-07 13:49:28 +01:00
autobuild.sh
conf.py
index.rst
logo.png
Makefile
README.md
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.