Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-16 16:00:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix doc

Browse Source
This commit is contained in:
T'rahk Rokym 2025-05-19 23:04:26 +02:00
parent aa21cab967
commit 5cb5aef7e4
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
allianceauth/services/hooks.py
View File

@ -148,7 +148,7 @@ class MenuItemHook(MenuItemHook):
class AppAnnouncementHook(AppAnnouncementHook): class AppAnnouncementHook(AppAnnouncementHook):
""" """
AppAnnouncementHook shim to allianceauth.templatetags.admin_status AppAnnouncementHook shim to allianceauth.admin_status.hooks
:param AppAnnouncementHook: _description_ :param AppAnnouncementHook: _description_
:type AppAnnouncementHook: _type_ :type AppAnnouncementHook: _type_

8
docs/development/custom/app-announcement-hooks.md
View File

@ -9,7 +9,7 @@ To register an AppAnnouncementHook class, you would do the following:
```python ```python
from allianceauth import hooks from allianceauth import hooks
from allianceauth.admin_status.hooks import AppAnnouncementHook from allianceauth.services.hooks import AppAnnouncementHook
@hooks.register('app_announcement_hook') @hooks.register('app_announcement_hook')
@ -35,14 +35,14 @@ Here you should enter the namespace of your repository.
The structure stays the same for both GitHub and GitLab repositories. \ The structure stays the same for both GitHub and GitLab repositories. \
A repository with the url `https://gitlab.com/username/appname` will have a namespace of `username/appname`. A repository with the url `https://gitlab.com/username/appname` will have a namespace of `username/appname`.
### repository_kind ### Service
This variable is an enumeration of the class `AppAnnouncemementHook.RepositoryKind` This variable is an enumeration of the class `AppAnnouncemementHook.Service`
It is mandatory to specify this variable so alliance auth contacts the correct API when fetching your repository issues. It is mandatory to specify this variable so alliance auth contacts the correct API when fetching your repository issues.
```{eval-rst} ```{eval-rst}
.. autoclass:: allianceauth.services.hooks.AppAnnouncementHook.RepositoryKind .. autoclass:: allianceauth.services.hooks.AppAnnouncementHook.Service
:members: GITLAB, GITHUB :members: GITLAB, GITHUB
:undoc-members: :undoc-members:
``` ```

BIN
docs/development/custom/img/app_announcement_hook_example.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 29 KiB