0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
2015-06-16 13:09:33 +01:00
..
_static/images Add the Wagtail tutorial to docs 2015-06-01 15:30:07 +01:00
advanced_topics Moved page privacy to advanced topics 2015-06-02 09:14:55 +01:00
contributing
editor_manual
getting_started Use correct template tags for {{ self.intro }} 2015-06-15 18:42:34 +01:00
reference Moved theory doc into reference 2015-06-05 13:54:15 +01:00
releases changelog entry for #1406 2015-06-15 16:26:08 +01:00
topics Support overriding form classname and template within StructBlock 2015-06-16 13:09:33 +01:00
autobuild.sh
conf.py
index.rst Add the Wagtail tutorial to docs 2015-06-01 15:30:07 +01:00
logo.png
Makefile
README.md Fix typo 2015-06-01 16:55:55 +01: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 requirements-dev.txt

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.