0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2016-08-18 12:05:33 +01:00
..
_static/images promote rich text link handling to a major feature 2016-05-19 17:01:17 +01:00
advanced_topics Remove deprecated wagtail.wagtailimages.utils module 2016-08-09 20:11:31 +01:00
contributing Add 'issue tracking' docs (#2794) 2016-07-19 16:17:54 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Make /admin a link in the Getting Started tutorial 2016-07-20 09:41:03 +01:00
reference Mark django-medusa as no longer maintained 2016-07-29 15:54:52 +01:00
releases Release note for #2877 2016-08-18 12:05:33 +01:00
topics Add usage examples for EmailBlock, IntegerBlock, DecimalBlock 2016-08-08 20:15:45 +01:00
autobuild.sh
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
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.