0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-04-20 11:56:09 +01:00
..
_static Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
advanced_topics Allow custom image model to have fields defined as required 2020-04-20 14:46:24 +10:00
contributing Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00
editor_manual Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
getting_started Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00:00
reference Update BaseSetting to make it easier to utilise QuerySet.select_related() for more complex settings which reference related objects (such as pages) 2020-04-03 22:01:08 +01:00
releases Release note for #5927 2020-04-20 11:56:09 +01:00
topics Remove remaining references to request.site 2020-02-17 12:06:19 +00:00
autobuild.sh
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
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10: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.