0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 13:10:14 +01:00
wagtail/docs
Sage Abdullah 014ffb5ce9 Ensure the side panel's show event is dispatched after any hide events
If the event is dispatched in the loop, then the show event may be
dispatched before the hide event is dispatched. For example, if you're
switching from the checks panel to the preview panel, as the preview
panel is ordered before the checks panel in the DOM.

This could cause an issue with the preview panel code, where we listen
for the show event to activate the auto update, and listen to the hide
event to deactivate it. We're listening to both the preview and checks
side panels.

Without this fix, the preview auto-update will get deactivated upon
switching from the checks panel to the preview panel, as the hide event
is dispatched after the show event.
2024-09-19 08:22:54 +10:00
..
_static doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
_templates
advanced_topics Release note for #12310 / document support for MariaDB 2024-09-12 19:11:22 +01:00
contributing Docs - Hacktoberfest - Remove reference to the t-shirt 2024-09-19 08:03:36 +10:00
deploy Use non-tracked links in Divio hosting details 2024-09-17 14:37:08 +01:00
editor_manual
extending Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
getting_started Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
public
reference Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
releases Ensure the side panel's show event is dispatched after any hide events 2024-09-19 08:22:54 +10:00
topics Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
tutorial Add official hosting documentation 2024-09-03 07:59:20 +10:00
conf.py doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
favicon.ico
index.rst Add official hosting documentation 2024-09-03 07:59:20 +10:00
logo.png
Makefile Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
README.md
spelling_wordlist.txt
support.md Update twitter link in support docs to x.com (#12205) 2024-08-05 13:54:37 +01:00

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.