Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Broker Documentation #779

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api/tom_alerts/brokers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ ALeRCE
ANTARES
*******

.. automodule:: tom_alerts.brokers.antares
:members:

.. automodule:: tom_antares.antares
:members:

Expand All @@ -36,6 +39,9 @@ Lasair
Hermes
******

.. automodule:: tom_alerts.brokers.hermes
:members:

.. automodule:: tom_hermes.hermes
:members:

Expand Down
9 changes: 9 additions & 0 deletions tom_alerts/brokers/antares.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ def __init__(self, *args, **kwargs):


class ANTARESBroker(GenericBroker):
"""
In order to install the Antares Broker plugin, please see
these instructions at https://github.com/TOMToolkit/tom_antares.

There is a known compatibility issue with antares-client required for the TOM_Antares Broker.
The antares-client requires the librdkafka library to be installed in order to be compatible with Python 3.10.
You can learn more about this on the
antares-client website (https://nsf-noirlab.gitlab.io/csdc/antares/client/installation.html) .
"""
name = 'ANTARES'
form = ANTARESQueryForm

Expand Down
3 changes: 3 additions & 0 deletions tom_alerts/brokers/hermes.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ def __init__(self, *args, **kwargs):


class HermesBroker(GenericBroker):
"""
In order to install the full plugin, please see the instructions at https://github.com/TOMToolkit/tom_hermes.
"""
name = 'Hermes'
form = HermesQueryForm

Expand Down
Loading