wagtail/docs
Sævar Öfjörð Magnússon 9d10e28214
Update wagtail app list to match installed apps in documentation
2020-10-06 15:03:39 +01:00
..
_static Update editor manual images where they show the old edit/workflow admin views before revamp 2020-08-07 17:10:26 +01:00
advanced_topics Update wagtail app list to match installed apps in documentation 2020-10-06 15:03:39 +01:00
contributing deprecated 2020-10-05 14:23:50 +01:00
editor_manual Remove reference to photographer credit in documentation, add reference to title 2020-10-05 12:34:26 +01:00
getting_started Lint docs with doc8 2020-10-03 14:43:03 +01:00
reference remove trailing whitespace to placate doc8 2020-10-05 12:44:57 +01:00
releases Release note / additional fix for #6339 2020-10-05 14:25:33 +01:00
topics ElasticSearch => Elasticsearch 2020-10-03 14:43:03 +01:00
Makefile Lint docs with doc8 2020-10-03 14:43:03 +01:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Flake8 all other Python files 2020-10-05 14:27:50 +01: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 Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00

README.md

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.