wagtail/docs
Matt Westcott f16965442e 2.1 -> 2.2 2019-04-01 20:28:34 +01:00
..
_static Make the page reordering UI easier to find (#5187) 2019-03-29 14:38:05 +00:00
advanced_topics Fix warnings on building documentation (#5145) 2019-03-15 02:03:56 +01:00
contributing Recommend `npm install --no-save` when setting up node toolchain (#5161) 2019-03-21 20:41:14 +00:00
editor_manual Make the page reordering UI easier to find (#5187) 2019-03-29 14:38:05 +00:00
getting_started Formalise support for Django 2.2 2019-04-01 19:59:04 +01:00
reference add name attribute to all derived classes of ActionMenuItem 2019-03-29 11:48:15 +00:00
releases 2.1 -> 2.2 2019-04-01 20:28:34 +01:00
topics Add documentation for the ajax_template attribute 2019-03-29 11:25:01 +00:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Add note about not asking support questions in multiple places 2018-07-11 11:09:45 +01:00

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.