Documentation

CONTRIBUTING.md

@@ -15,7 +15,7 @@ With your preferred virtualenv activated, install testing dependencies:
 
 ```sh
 python -m pip install --upgrade 'pip>=21.3'
-python -m pip install -e '.[testing]' -U
+python -m pip install -e '.[testing,ci,mailchimp,mrml]' -U
 ```
 
 ### Using flit
@@ -48,8 +48,8 @@ Now you can run tests as shown below:
 tox
 ```
 
-or, you can run them for a specific environment `tox -e python3.11-django4.2-wagtail5.1` or specific test
-`tox -e python3.11-django4.2-wagtail5.1-sqlite wagtail-newsletter.tests.test_file.TestClass.test_method`
+or, you can run them for a specific environment `tox -e python3.12-django5.0-wagtail6.1` or specific test
+`tox -e python3.12-django5.0-wagtail6.1-sqlite wagtail-newsletter.tests.test_file.TestClass.test_method`
 
 To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.
 

demo/README.md

@@ -17,6 +17,7 @@ export WAGTAIL_NEWSLETTER_MAILCHIMP_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-us1
 export WAGTAIL_NEWSLETTER_FROM_NAME="My Newsletter"
 export [email protected]
 
+python -m pip install --editable='.[testing,mailchimp,mrml]'
 ./demo/manage.py migrate
 ./demo/manage.py createcachetable
 ./demo/manage.py createsuperuser

demo/fields.py

@@ -1,9 +1,9 @@
 import json
 
-from wagtail.fields import StreamField as WagtailStreamfield
+from wagtail.fields import StreamField as WagtailStreamField
 
 
-class StreamField(WagtailStreamfield):
+class StreamField(WagtailStreamField):
     def __init__(self, *args, **kwargs):
         """
         Overrides StreamField.__init__() to account for `block_types` no longer

docs/customization.rst

@@ -98,7 +98,7 @@ distinguish between newsletter and web rendering.
           context["rendering_newsletter"] = True
           return context
 
-Then we can define a ``Streamfield`` block that only renders its content if the
+Then we can define a ``StreamField`` block that only renders its content if the
 flag is set (or, for web-only content, if the flag is missing):
 
 .. code-block:: python