📝 Add changelog to docs and fix some styling errors

maykinmedia · Dec 20, 2024 · fb0f811 · fb0f811
1 parent d0adf45
commit fb0f811
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,29 +5,30 @@ Changelog
 0.4.0 (2024-12-12)
 ------------------
 
-* Added an `identifier` field to the ``Subscription`` model
-* Introduced support for ``django-setup-configuration`` and added two 
+* Added an ``identifier`` field to the ``Subscription`` model
+* Introduced support for ``django-setup-configuration`` and added two
   ``ConfigurationStep`` implementations: ``NotificationConfigurationStep`` and
   ``NotificationSubscriptionConfigurationStep``
 
 0.3.1 (2024-10-27)
 ------------------
 
-* Fixed kanalen not being registered. This regression was introduced in `0.3.0`.
+* Fixed kanalen not being registered. This regression was introduced in ``0.3.0``.
 
 0.3.0 (2024-10-24)
 ------------------
 
 * Upgraded Django requirement  to >= 4.2
 * Upgraded minimum python requirement to >= 3.10
 * Added python 3.12 support
-* Added the `NOTIFICATIONS_GUARANTEE_DELIVERY` environment variable which allows
-  `RuntimeError`s to be raised (or not to) whenever no Notifications API is
-  configured. The default for this setting is set to `True`.
+* Added the ``NOTIFICATIONS_GUARANTEE_DELIVERY`` environment variable which allows
+  ``RuntimeError`` to be raised (or not to) whenever no Notifications API is
+  configured. The default for this setting is set to ``True``.
 * Upgraded zgw-consumers to 0.35.1
-  * This removed support for retrieving external OAS files to determine
-  * This requires `zgw_consumers.models.Service` ("service") instances to be
-    created to do external API calls through `zgw_consumer`
+
+    * This removed support for retrieving external OAS files to determine
+    * This requires ``zgw_consumers.models.Service`` ("service") instances to be
+      created to do external API calls through ``zgw_consumers``
 
 0.2.2 (2023-04-20)
 ------------------

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -24,6 +24,7 @@ Features
 
    quickstart
    setup_config
+   changelog
 
 
 Indices and tables