0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 17:13:31 +01:00
wagtail/docs
Dan Braghis 247bfe883f Further tidy up following code review
Co-Authored-By: Thibaud Colas <thibaudcolas@gmail.com>
2021-10-15 16:51:18 +01:00
..
_static Update editorial images and add content for bulk actions 2021-10-15 16:51:18 +01:00
_templates
advanced_topics add ability to customise the pre-filled document title 2021-10-15 18:25:23 +10:00
contributing update documentation & 2.15 release to drop IE11 support 2021-10-04 12:35:58 +01:00
editor_manual Update editorial images and add content for bulk actions 2021-10-15 16:51:18 +01:00
extending Tidy up based on code review 2021-10-15 16:51:18 +01:00
getting_started Replace unneeded length filter 2021-10-14 13:25:03 +01:00
reference Further tidy up following code review 2021-10-15 16:51:18 +01:00
releases Set the bound field label with the heading argument 2021-10-15 23:43:17 +10:00
topics Create new permission policy CollectionMangementPermissionPolicy 2021-10-15 00:44:05 +01:00
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
Makefile
README.md
requirements.txt
robots.txt
spelling_wordlist.txt
support.rst

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.io when the main 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.