docs(config): autogenerate notification configuration options

Author: michael-smt

docs/Makefile

@@ -53,6 +53,7 @@ update-docs:
 	@uv run --no-sync ../manage.py list_checks -s checks -o snippets/checks-autogenerated.rst
 	@uv run --no-sync ../manage.py list_checks -s flags -o snippets/check-flags-autogenerated.rst
 	@uv run --no-sync ../manage.py list_format_features -o snippets/format-features
+	@uv run --no-sync ../manage.py list_notification_config -o snippets/notifications-config.rst
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/admin/config.rst

@@ -812,78 +812,7 @@ Default notification settings for every created user.
 
 A list of 3-tuples consisting of notification scope, notification frequency and notification handler.
 
-Scopes:
-
-``0``
-   :guilabel:`All`
-``10``
-   :guilabel:`Watched`
-``20``
-   :guilabel:`Administered`
-``30``
-   :guilabel:`Project`
-``40``
-   :guilabel:`Component`
-
-Frequencies:
-
-``0``
-   :guilabel:`No notification`
-``1``
-   :guilabel:`Instant notification`
-``2``
-   :guilabel:`Daily digest`
-``3``
-   :guilabel:`Weekly digest`
-``4``
-   :guilabel:`Monthly digest`
-
-Handlers:
-
-``RepositoryNotification``
-   :guilabel:`Operation was performed in the repository`
-``LockNotification``
-   :guilabel:`Component was locked or unlocked`
-``LicenseNotification``
-   :guilabel:`License was changed`
-``ParseErrorNotification``
-   :guilabel:`Parse error occurred`
-``NewStringNotificaton``
-   :guilabel:`String is available for translation`
-``NewContributorNotificaton``
-   :guilabel:`Contributor made their first translation`
-``NewSuggestionNotificaton``
-   :guilabel:`Suggestion was added`
-``LanguageTranslatedNotificaton``
-   :guilabel:`Language was translated`
-``ComponentTranslatedNotificaton``
-   :guilabel:`Component was translated`
-``NewCommentNotificaton``
-   :guilabel:`Comment was added`
-``MentionCommentNotificaton``
-   :guilabel:`You were mentioned in a comment`
-``LastAuthorCommentNotificaton``
-   :guilabel:`Your translation received a comment`
-``TranslatedStringNotificaton``
-   :guilabel:`String was edited by user`
-``ApprovedStringNotificaton``
-   :guilabel:`String was approved`
-``ChangedStringNotificaton``
-   :guilabel:`String was changed`
-``NewTranslationNotificaton``
-   :guilabel:`New language was added or requested`
-``NewComponentNotificaton``
-   :guilabel:`New translation component was created`
-``NewAnnouncementNotificaton``
-   :guilabel:`Announcement was published`
-``NewAlertNotificaton``
-   :guilabel:`New alert emerged in a component`
-``MergeFailureNotification``
-   :guilabel:`Repository operation failed`
-``PendingSuggestionsNotification``
-   :guilabel:`Pending suggestions exist`
-``ToDoStringsNotification``
-   :guilabel:`Unfinished strings exist`
+.. include:: /snippets/notifications-config.rst
 
 .. note::
 

docs/admin/management.rst

@@ -827,6 +827,17 @@ list_machinery
 
 Lists automatic suggestions services in reStructuredText as a template for :doc:`/admin/machine`.
 
+.. seealso::
+
+   :doc:`/contributing/documentation`
+
+list_notification_config
+------------------------
+
+.. weblate-admin:: list_notification_config
+
+Lists notification scopes, frequencies and handlers in reStructuredText as a template for :doc:`/admin/config`.
+
 .. seealso::
 
    :doc:`/contributing/documentation`

docs/snippets/notifications-config.rst

@@ -0,0 +1,89 @@
+Scopes:
+
+.. AUTOGENERATED START: notification-scopes
+.. This section is automatically generated by `./manage.py list_notification_config`. Do not edit manually.
+
+``0``
+   :guilabel:`All`
+``10``
+   :guilabel:`Watched`
+``20``
+   :guilabel:`Administered`
+``30``
+   :guilabel:`Project`
+``40``
+   :guilabel:`Component`
+
+.. AUTOGENERATED END: notification-scopes
+
+Frequencies:
+
+.. AUTOGENERATED START: notification-frequencies
+.. This section is automatically generated by `./manage.py list_notification_config`. Do not edit manually.
+
+``0``
+   :guilabel:`No notification`
+``1``
+   :guilabel:`Instant notification`
+``2``
+   :guilabel:`Daily digest`
+``3``
+   :guilabel:`Weekly digest`
+``4``
+   :guilabel:`Monthly digest`
+
+.. AUTOGENERATED END: notification-frequencies
+
+Handlers:
+
+.. AUTOGENERATED START: notification-handlers
+.. This section is automatically generated by `./manage.py list_notification_config`. Do not edit manually.
+
+``ApprovedStringNotificaton``
+   :guilabel:`String was approved`
+``ChangedStringNotificaton``
+   :guilabel:`String was changed`
+``ComponentTranslatedNotificaton``
+   :guilabel:`Component was translated`
+``LanguageTranslatedNotificaton``
+   :guilabel:`Language was translated`
+``LastAuthorCommentNotificaton``
+   :guilabel:`Your translation received a comment`
+``LicenseNotification``
+   :guilabel:`License was changed`
+``LockNotification``
+   :guilabel:`Component was locked or unlocked`
+``MentionCommentNotificaton``
+   :guilabel:`You were mentioned in a comment`
+``MergeFailureNotification``
+   :guilabel:`Repository operation failed`
+``NewAlertNotificaton``
+   :guilabel:`New alert emerged in a component`
+``NewAnnouncementNotificaton``
+   :guilabel:`Announcement was published`
+``NewCommentNotificaton``
+   :guilabel:`Comment was added`
+``NewComponentNotificaton``
+   :guilabel:`New translation component was created`
+``NewContributorNotificaton``
+   :guilabel:`Contributor made their first translation`
+``NewStringNotificaton``
+   :guilabel:`String is available for translation`
+``NewSuggestionNotificaton``
+   :guilabel:`Suggestion was added`
+``NewTranslationNotificaton``
+   :guilabel:`New language was added or requested`
+``ParseErrorNotification``
+   :guilabel:`Parse error occurred`
+``PendingSuggestionsNotification``
+   :guilabel:`Pending suggestions exist`
+``RepositoryNotification``
+   :guilabel:`Operation was performed in the repository`
+``ToDoStringsNotification``
+   :guilabel:`Unfinished strings exist`
+``TranslatedStringNotificaton``
+   :guilabel:`String was edited by user`
+``TranslationActivitySummaryNotification``
+   :guilabel:`Translation activity summary`
+
+.. AUTOGENERATED END: notification-handlers

weblate/accounts/management/commands/list_notification_config.py

@@ -0,0 +1,54 @@
+# Copyright © Michal Čihař <michal@weblate.org>
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from weblate.accounts.notifications import (
+    NOTIFICATIONS,
+    NotificationFrequency,
+    NotificationScope,
+)
+from weblate.utils.management.base import DocGeneratorCommand
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from weblate.accounts.notifications import (
+        Notification,
+    )
+
+
+def sorted_handlers(handlers: Iterable[Notification]) -> Iterable[Notification]:
+    return sorted(handlers, key=lambda handler: handler.__name__)
+
+
+class Command(DocGeneratorCommand):
+    help = "Lists notification scopes, frequencies and handlers"
+
+    def handle(self, *args, **options) -> None:
+        """List notification scopes, frequencies and handlers."""
+        scope_content = []
+        for scope in NotificationScope:
+            scope_content.extend(
+                [f"``{scope.value}``", f"   :guilabel:`{scope.label}`"]
+            )
+        self.add_section("notification-scopes", scope_content)
+
+        frequency_content = []
+        for scope in NotificationFrequency:
+            frequency_content.extend(
+                [f"``{scope.value}``", f"   :guilabel:`{scope.label}`"]
+            )
+        self.add_section("notification-frequencies", frequency_content)
+
+        handler_content = []
+        for handler in sorted_handlers(NOTIFICATIONS):
+            handler_content.extend(
+                [f"``{handler.__name__}``", f"   :guilabel:`{handler.verbose}`"]
+            )
+        self.add_section("notification-handlers", handler_content)
+
+        self.write_sections(options.get("output"))