wagtail/docs
Matt Westcott 14a57215ed Avoid importing custom user models at load time in wagtail.admin.models
As per https://docs.djangoproject.com/en/5.0/topics/auth/customizing/#referencing-the-user-model , module-level code such as ForeignKey definitions should use `AUTH_USER_MODEL` rather than `get_user_model()`.

Probably fixes #12228 (unconfirmed)
2024-08-15 11:09:03 +01:00
..
_static doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
_templates Extend the until date of the promotion banner for Wagtail Space 2024-06-13 15:16:29 +02:00
advanced_topics Do not suggest using the custom user model's app config as the custom wagtail.users app config 2024-07-29 17:36:10 +01:00
contributing Mention use of GitHub's security advisories 2024-05-08 12:34:39 +01:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Fix typo in admin url finder docs (#12193) 2024-08-01 11:49:04 +01:00
getting_started Update "integrating into Django" docs to emphasise creating page models 2024-04-23 08:18:07 +10:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Fix no-index directive for Sphinx 7.4.7 2024-08-01 14:41:30 +01:00
releases Avoid importing custom user models at load time in wagtail.admin.models 2024-08-15 11:09:03 +01:00
topics Remove note about database search not ordering by relevance 2024-07-24 22:32:54 +01:00
tutorial Update deployment instructions for Fly.io 2024-06-17 12:29:51 +01:00
Makefile Downgrade minimum version of Sphinx for Python 3.8 compatibility 2024-07-19 12:01:18 +01:00
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
conf.py doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
favicon.ico Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
index.rst Rename "advanced tutorial" to "full tutorial" (#11260) 2023-11-20 15:22:52 +00:00
logo.png Update all other Wagtail logos to the latest version 2024-03-23 19:48:31 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Remove mention of Wagtail Google group 2023-12-15 11:29:45 +00:00

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.