0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2019-11-06 13:06:22 +00:00
..
_static Admin documents listing - rename 'uploaded' to 'created 2019-10-24 07:40:59 +10:00
advanced_topics Add Recipe doc for implementing AMP on a site (#5626) 2019-11-05 15:28:45 +00:00
contributing Move flake8 config to setup.cfg 2019-10-23 18:09:07 +02:00
editor_manual Admin documents listing - rename 'uploaded' to 'created 2019-10-24 07:40:59 +10:00
getting_started Formalise Python 3.8 support 2019-10-22 16:23:44 +01:00
reference Remove old versionadded tags in the docs 2019-10-29 08:56:12 +00:00
releases Fill in release date for 2.7 2019-11-06 13:06:22 +00:00
topics syntax => keyword 2019-10-16 16:24: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.