wagtail/docs
Neil Lyons f10c5cab58 Update docs for construct_homepage_panels hook (#5109)
`construct_homepage_panels` hook doesn't need a return statement.

[Looking at the code](https://github.com/wagtail/wagtail/blob/master/wagtail/admin/views/home.py#L101-L102), the user doesn't need to return a list, they need to mutate the list passed in.
2019-02-27 14:50:01 +00:00
..
_static Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
advanced_topics Add limit image upload size by number of pixels (#5097) 2019-02-23 14:13:00 +00:00
contributing First positional argument for tox as test module/case path 2018-10-30 12:16:45 +00:00
editor_manual Update links to Draftail documentation 2019-02-14 23:24:30 +01:00
getting_started Add MEDIA_* settings to Django integration page (#5046) 2019-01-31 12:19:42 +00:00
reference Update docs for construct_homepage_panels hook (#5109) 2019-02-27 14:50:01 +00:00
releases Release note / contributor for #5097 2019-02-23 14:15:07 +00:00
topics Fix typo in docs (#5103) 2019-02-26 21:46:23 +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.