add links to corresponding options in services docstrings

linkfrg · Jan 6, 2025 · c66f94e · c66f94e
1 parent 71157f6
commit c66f94e
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 4 deletions.
diff --git a/ignis/options.py b/ignis/options.py
@@ -42,7 +42,7 @@ def __init__(self):
 
     class Notifications(OptionsGroup):
         """
-        Options for the NotificationsService
+        Options for the :class:`~ignis.services.notifications.NotificationService`.
         """
 
         #: Do Not Disturb mode.
@@ -61,7 +61,7 @@ class Notifications(OptionsGroup):
 
     class Recorder(OptionsGroup):
         """
-        Options for the Recorder Service
+        Options for the :class:`~ignis.services.recorder.RecorderService`.
         """
 
         #: The bitrate of the recording.
@@ -75,7 +75,7 @@ class Recorder(OptionsGroup):
 
     class Applications(OptionsGroup):
         """
-        Options for the Applications Service
+        Options for the :class:`~ignis.services.applications.ApplicationsService`.
         """
 
         #: A list of the pinned applications desktop files, e.g. ``"firefox.desktop"``, ``"code.desktop"``.
@@ -85,7 +85,7 @@ class Applications(OptionsGroup):
 
     class Wallpaper(OptionsGroup):
         """
-        Options for the Wallpaper Service
+        Options for the :class:`~ignis.services.wallpaper.WallpaperService`.
         """
 
         #: The path to the wallpaper image.

diff --git a/ignis/services/applications/service.py b/ignis/services/applications/service.py
@@ -9,6 +9,8 @@ class ApplicationsService(BaseService):
     Provides a list of applications installed on the system.
     It also allows "pinning" of apps and retrieving a list of pinned applications.
 
+    There are options available for this service: :class:`~ignis.options.Options.Applications`.
+
     Example usage:
 
     .. code-block:: python

diff --git a/ignis/services/notifications/service.py b/ignis/services/notifications/service.py
@@ -22,6 +22,8 @@ class NotificationService(BaseService):
     A notification daemon.
     Allow receiving notifications and perform actions on them.
 
+    There are options available for this service: :class:`~ignis.options.Options.Notifications`.
+
     Raises:
         AnotherNotificationDaemonRunningError: If another notification daemon is already running.
 

diff --git a/ignis/services/recorder/service.py b/ignis/services/recorder/service.py
@@ -20,6 +20,8 @@ class RecorderService(BaseService):
     Uses XDG Desktop portal and PipeWire.
     Allow record screen with microphone audio and internal system audio.
 
+    There are options available for this service: :class:`~ignis.options.Options.Recorder`.
+
     Dependencies:
         - GStreamer
         - PipeWire

diff --git a/ignis/services/wallpaper/service.py b/ignis/services/wallpaper/service.py
@@ -12,6 +12,8 @@ class WallpaperService(BaseService):
     A simple service to set the wallpaper.
     Supports multiple monitors.
 
+    There are options available for this service: :class:`~ignis.options.Options.Wallpaper`.
+
     Example usage:
 
     .. code-block:: python