mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-16 07:50:16 +02:00
Fix doc
This commit is contained in:
parent
aa21cab967
commit
5cb5aef7e4
@ -148,7 +148,7 @@ class MenuItemHook(MenuItemHook):
|
||||
|
||||
class AppAnnouncementHook(AppAnnouncementHook):
|
||||
"""
|
||||
AppAnnouncementHook shim to allianceauth.templatetags.admin_status
|
||||
AppAnnouncementHook shim to allianceauth.admin_status.hooks
|
||||
|
||||
:param AppAnnouncementHook: _description_
|
||||
:type AppAnnouncementHook: _type_
|
||||
|
@ -9,7 +9,7 @@ To register an AppAnnouncementHook class, you would do the following:
|
||||
|
||||
```python
|
||||
from allianceauth import hooks
|
||||
from allianceauth.admin_status.hooks import AppAnnouncementHook
|
||||
from allianceauth.services.hooks import AppAnnouncementHook
|
||||
|
||||
|
||||
@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. \
|
||||
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.
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: allianceauth.services.hooks.AppAnnouncementHook.RepositoryKind
|
||||
.. autoclass:: allianceauth.services.hooks.AppAnnouncementHook.Service
|
||||
:members: GITLAB, GITHUB
|
||||
:undoc-members:
|
||||
```
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 29 KiB |
Loading…
x
Reference in New Issue
Block a user