wagtail/docs
Matt Westcott 1829ed3dbe Avoid importing document model class from wagtail.documents.permissions and wagtail.documents.views.chooser
Fixes #9118. Permission policies can now be initialised by passing a model string rather than a class; wagtail.admin.widgets.chooser.BaseChooser had this capability already. Between these, we can adjust wagtail.documents.views.chooser so that no models need to be imported at module load time. As a result, definitions that depend on this module (such as DocumentChooserBlock) can now be included in the same models file as a custom document model, without causing a circular import.
2022-09-05 10:49:45 +01:00
..
_static fix styling regression for pagination (search results) in dark mode 2022-08-26 06:59:26 +10:00
_templates update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
advanced_topics Add ability to set default configurable attributes to image tags 2022-08-25 18:20:45 +10:00
contributing Fix dead Transifex links 2022-08-19 17:28:31 +10:00
editor_manual clean up spelling of multi-site 2022-08-25 22:06:31 +10:00
extending Update admin_views.md 2022-08-22 12:52:04 +10:00
getting_started
reference Add docs & changelog for form builder FormMixin & EmailFormMixin 2022-08-31 23:12:27 +10:00
releases Avoid importing document model class from wagtail.documents.permissions and wagtail.documents.views.chooser 2022-09-05 10:49:45 +01:00
topics Add ability to set default configurable attributes to image tags 2022-08-25 18:20:45 +10:00
Makefile
README.md
autobuild.sh
conf.py
favicon.ico
index.rst
logo.png
requirements.txt update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
robots.txt
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 editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.