0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
2021-10-25 11:23:35 +01:00
..
_static Update editorial images and add content for bulk actions 2021-10-15 16:51:18 +01:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
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 Fix typos and remove unwanted code from bulk actions (#7613) 2021-10-15 16:51:18 +01:00
extending Fix Python code blocks, indent lines with multiple of 4 spaces 2021-10-18 12:37:26 +01:00
getting_started Replace unneeded length filter 2021-10-14 13:25:03 +01:00
reference Fix TableBlock -> TypedTableBlock in code samples 2021-10-18 12:42:20 +01:00
releases Start changelog for 2.16 2021-10-25 11:23:35 +01:00
topics Create new permission policy CollectionMangementPermissionPolicy 2021-10-15 00:44:05 +01:00
autobuild.sh
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico
index.rst Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
logo.png
Makefile
README.md
requirements.txt Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
robots.txt
spelling_wordlist.txt
support.rst Link to Github discussion boards 2021-09-30 19:00:18 +10:00

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.