0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-11-05 12:04:12 +00: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 Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
contributing Drop travis entirely 2020-11-05 12:04:12 +00:00
editor_manual fix trailing whitespace 2020-10-21 12:12:34 +01:00
getting_started Formalise support for Python 3.9 2020-11-02 17:29:58 +00:00
reference Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
releases Additional safeguard to check if a cached site is from an older version of Wagtail (#6515) 2020-11-04 12:22:43 +00:00
topics Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
autobuild.sh
conf.py Lint config fixes (#6473) 2020-10-19 21:33:10 +01:00
favicon.ico
index.rst
logo.png
Makefile Add config section for doc8 in setup.cfg and ignore _build dir 2020-10-21 12:39:32 +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.