0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Tom Dyson 6d7a82cfb2 Fix update docs typo
Only two Ss in accessor. Also make quotes consistent.
2019-07-09 17:50:24 +01:00
..
_static Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
advanced_topics Update third_party_tutorials.rst 2019-06-25 16:07:06 +01:00
contributing Adjust link label 2019-06-25 12:10:34 +01:00
editor_manual Adds Collections section to editor's guide 2019-06-17 10:13:49 +01:00
getting_started Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
reference added construction_hook_name to settings_menu (#5384) 2019-06-25 12:04:53 +01:00
releases Fix update docs typo 2019-07-09 17:50:24 +01:00
topics Add support for custom search handler classes to ModelAdmin's IndexView 2019-06-08 17:57:24 +01: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
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
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

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.