wagtail/docs
Matt Westcott ab7547c6cb
Add upgrade note about fixing tests for background tasks (#12794)
* Add upgrade note about fixing tests for background tasks

Addition to the upgrade note added in https://github.com/wagtail/wagtail/pull/12787 to cover how to update tests that make database changes and expect to see the results reflected immediately in search queries and other processes that now only happen at the end of a transaction.

* Update docs/releases/6.4.md

Co-authored-by: sag​e <laymonage@gmail.com>

---------

Co-authored-by: sag​e <laymonage@gmail.com>
2025-01-20 16:08:47 +00:00
..
_static Addressed feedback: Updated FieldPanel documentation 2025-01-06 19:26:26 +00:00
_templates
advanced_topics Update accessibility concerns docs in light of GSOC contextual alt text project 2025-01-20 11:46:54 +00:00
contributing Update documented Safari support version numbers 2025-01-17 13:50:12 +00:00
deployment
editor_manual
extending typo fix 2025-01-02 09:16:07 +00:00
getting_started Continuity fixes for tutorial 2025-01-06 23:11:53 +00:00
public
reference Nest code snippets for string panel definitions inside the note 2025-01-06 19:29:44 +00:00
releases Add upgrade note about fixing tests for background tasks (#12794) 2025-01-20 16:08:47 +00:00
topics Update accessibility concerns docs in light of GSOC contextual alt text project 2025-01-20 11:46:54 +00:00
tutorial
Makefile
README.md
conf.py Work around Sphinx failing to resolve HttpRequest in type annotations 2025-01-16 16:00:14 +00:00
favicon.ico
index.rst
logo.png
spelling_wordlist.txt
support.md

README.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.