0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2016-08-26 16:23:31 +01:00
..
_static/images Added documentation for editors to configure redirects 2016-08-25 11:18:55 +01:00
advanced_topics Add setting to disable Unicode slug support #2937 2016-08-25 19:03:37 +03:00
contributing Add 'issue tracking' docs (#2794) 2016-07-19 16:17:54 +01:00
editor_manual Added documentation for editors to configure redirects 2016-08-25 11:18:55 +01:00
getting_started Bumped supported Django version to 1.10 2016-08-25 10:09:08 +01:00
reference Mark django-medusa as no longer maintained 2016-07-29 15:54:52 +01:00
releases Mention WAGTAIL_ALLOW_UNICODE_SLUGS setting in release notes 2016-08-26 16:23:31 +01:00
topics Restore PageManager behaviour by setting it on an abstract superclass of Page 2016-08-23 20:12:22 +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.