diff --git a/documentation/api/source/plugins/alerts.rst b/documentation/api/source/plugins/alerts.rst new file mode 100644 index 000000000..e7cf33d63 --- /dev/null +++ b/documentation/api/source/plugins/alerts.rst @@ -0,0 +1,31 @@ +.. _plugins-alerts: + +Alerts Plugin +============= + +.. automodule:: openlp.plugins.alerts + :members: + +Plugin Class +------------ + +.. autoclass:: openlp.plugins.alerts.alertsplugin.AlertsPlugin + :members: + +Forms +----- + +.. automodule:: openlp.plugins.alerts.forms + :members: + +.. autoclass:: openlp.plugins.alerts.forms.alertform.AlertForm + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.alerts.lib + :members: + +.. automodule:: openlp.plugins.alerts.lib.db + :members: diff --git a/documentation/api/source/plugins/index.rst b/documentation/api/source/plugins/index.rst index ee248b1a0..78126ff9e 100644 --- a/documentation/api/source/plugins/index.rst +++ b/documentation/api/source/plugins/index.rst @@ -17,3 +17,4 @@ Plugins custom remotes songusage + alerts diff --git a/documentation/api/source/plugins/songusage.rst b/documentation/api/source/plugins/songusage.rst index d5227184b..e4804ea34 100644 --- a/documentation/api/source/plugins/songusage.rst +++ b/documentation/api/source/plugins/songusage.rst @@ -29,3 +29,6 @@ Helper Classes & Functions .. automodule:: openlp.plugins.songusage.lib :members: + +.. automodule:: openlp.plugins.songusage.lib.db + :members: