kopia lustrzana https://github.com/wagtail/wagtail
![]() * 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: sage <laymonage@gmail.com> --------- Co-authored-by: sage <laymonage@gmail.com> |
||
---|---|---|
.. | ||
_static | ||
_templates | ||
advanced_topics | ||
contributing | ||
deployment | ||
editor_manual | ||
extending | ||
getting_started | ||
public | ||
reference | ||
releases | ||
topics | ||
tutorial | ||
Makefile | ||
README.md | ||
conf.py | ||
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.