0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2020-10-05 12:26:00 +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 General spelling fixes 2020-10-03 14:43:03 +01:00
contributing Javascript => JavaScript 2020-10-03 14:43:03 +01:00
editor_manual Lint docs with doc8 2020-10-03 14:43:03 +01:00
getting_started Lint docs with doc8 2020-10-03 14:43:03 +01:00
reference Add validation for file extension in AbstractDocument using WAGTAIL_DOCS_EXTENSIONS setting (#6423) 2020-10-05 12:26:00 +01:00
releases Put quotes around some inline code 2020-10-03 14:43:03 +01:00
topics ElasticSearch => Elasticsearch 2020-10-03 14:43:03 +01:00
autobuild.sh
conf.py Change docs code block style to 'default' 2020-10-05 11:21:07 +01:00
favicon.ico
index.rst
logo.png
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
requirements.txt
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

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.