0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Lovelyfin00 b929694203 Migrate lock/unlock actions to w-action controller
- Revise 'redirect' from a string to a 'continue' boolean that defaults to false
- Use 'continue=true' for cases where we do not want to create a next param on submit that takes the user back to the current page
- Fixes #9815
2023-01-18 19:00:47 +10:00
..
_static Documentation - Fix missing links / images 2023-01-05 12:08:27 +00:00
_templates
advanced_topics Link django docs to stable version 2023-01-11 20:18:04 +10:00
contributing Remove react-axe package usage (#9865) 2023-01-10 11:12:19 +00:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Updated documentation for adding reports to cover permission restrictions (#9859) 2023-01-09 14:14:53 +00:00
getting_started Link django docs to stable version 2023-01-11 20:18:04 +10:00
public
reference Fix remaining imports deprecated in Wagtail 3.0 2023-01-11 13:35:39 +00:00
releases Migrate lock/unlock actions to w-action controller 2023-01-18 19:00:47 +10:00
topics Link django docs to stable version 2023-01-11 20:18:04 +10:00
autobuild.sh
conf.py Documentation - update package versions 2022-10-17 10:07:44 +01:00
favicon.ico
index.rst Re-add editor guide link (#9539) 2022-10-28 15:42:04 +01:00
logo.png
Makefile
README.md
requirements.txt Documentation - update package versions 2022-10-17 10:07:44 +01:00
spelling_wordlist.txt
support.md

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org 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 MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.