0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-24 19:17:48 +01:00
wagtail/docs
2015-06-22 10:28:24 +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 Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
editor_manual Fixed a couple of links in editor manual 2015-06-01 14:12:48 +01:00
getting_started Add requirements.txt to project template. 2015-06-17 17:00:29 +01:00
reference Merge pull request #1423 from kaedroho/staticsitegen-example-fix 2015-06-19 11:40:49 +01:00
releases remove 'in development' from 0.8.8 2015-06-18 16:38:21 +01:00
topics Removed contents and heading 2015-06-22 10:28:24 +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 Spellchecked editing api docs 2015-05-18 10:44:07 +01: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 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.