wagtail/docs
Tim Heap 254e675634 Use .. code-block:: console for all shell commands
This is the correct lexer for interactive console sessions, according to
<http://pygments.org/docs/lexers/>. This does require command lines to
be prefixed with `$`, otherwise they are interpreted as the output of a
command. It highlights the command nicely, including environment
variables, strings, and comments.
2016-11-28 13:41:35 +00:00
..
_static/images remove as-yet-unused tutorial screenshots for categories 2016-11-09 15:47:55 +00:00
advanced_topics Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
contributing Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
editor_manual Fix documentation typo (#3042) 2016-10-03 09:04:39 +01:00
getting_started Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
reference Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
releases Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
topics Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
Makefile
README.md
autobuild.sh
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst
logo.png
requirements.txt
spelling_wordlist.txt Added support for AWS CloudFront in Frontend cache invalidation module (#1845) 2016-08-29 15:15:27 +01:00
support.rst

README.md

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.