0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 03:31:04 +01:00
wagtail/docs
2020-05-08 00:11:05 +01:00
..
_static fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
advanced_topics Add ability to replace the default Wagtail logo in the userbar, via branding_logo block (#4731) 2020-05-08 00:11:05 +01:00
contributing Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +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 fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
releases Add ability to replace the default Wagtail logo in the userbar, via branding_logo block (#4731) 2020-05-08 00:11:05 +01:00
topics Update note on ATOMIC_REBUILD to indicate that the problem is specific to 5.4.x - fixes #6003 2020-05-07 21:45:35 +01:00
autobuild.sh
conf.py fix sphinx warnings (#6001) 2020-05-03 14:02:43 +02:00
favicon.ico
index.rst
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
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.