0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2016-04-28 15:22:10 +01:00
..
_static/images Promote the redesigned userbar to a major feature 2016-03-08 15:48:24 +00:00
advanced_topics Removed all uses of STATIC_URL from code samples, replaced with static(). 2016-04-28 10:57:22 +01:00
contributing Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
reference Removed all uses of STATIC_URL from code samples, replaced with static(). 2016-04-28 10:57:22 +01:00
releases Release note for #2501 2016-04-28 15:22:10 +01:00
topics Changed indentation on all code samples to 4 spaces. 2016-04-28 10:57:22 +01:00
autobuild.sh
conf.py
index.rst
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.