0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-02-16 21:18:11 +00:00
..
_static Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
advanced_topics Update links in docs to point at stable Django version 2019-12-01 13:19:40 +10:00
contributing Mention docker-wagtail-develop in developing docs (#5820) 2020-02-12 14:11:40 +01:00
editor_manual Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
getting_started Make Django 3.0 support official 2019-12-17 14:24:31 +00:00
reference Skip field validation when unpublishing pages. 2020-02-16 21:05:51 +00:00
releases Release notes for #5828 2020-02-16 21:18:11 +00:00
topics Implement MultipleChoiceBlock (rebase of #5592) (#5819) 2020-02-10 22:24:49 +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
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15: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 Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

Wagtail docs

These are Sphinx docs, automatically built at https://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.