0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 03:31:04 +01:00
wagtail/docs
2017-02-06 10:48:48 +00:00
..
_static/images Add 'Categories' section to tutorial 2017-02-03 21:24:54 +00:00
advanced_topics Updated docs to use a list for urlpatterns 2017-02-05 19:59:39 +00:00
contributing Removing errant words in sample path/to/wagtail 2017-02-03 20:41:08 +00:00
editor_manual Fix typo in editor guide intro 2017-02-05 17:25:19 +02:00
getting_started Release note for #3305 2017-02-03 21:24:57 +00:00
reference in Page reference docs, don't tell people to consult source code (#3303) 2017-01-28 00:11:52 +00:00
releases - Fix positional argument order when calling ModelAdmin.get_extra_class_names_for_field_col() and ModelAdmin.get_extra_attrs_for_field_col() from items_for_result() in template tags. 2017-02-06 10:48:48 +00:00
topics
autobuild.sh
conf.py
index.rst
logo.png
Makefile
README.md
requirements.txt
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
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.