From 9c7feb4c2e3176149504a6710260bad2e2f90c81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20S=C3=A1nchez-Gallego?= Date: Sat, 21 Dec 2024 16:05:17 -0800 Subject: [PATCH] Update docs API section --- docs/sphinx/api.rst | 44 +++++++++++++++++++++++++++++++++++----- src/lvmopstools/slack.py | 2 +- 2 files changed, 40 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst index 347fca7..5ace18b 100644 --- a/docs/sphinx/api.rst +++ b/docs/sphinx/api.rst @@ -8,18 +8,52 @@ Actor .. automodule:: lvmopstools.actor :members: +Ephemeris +--------- + +.. autofunction:: lvmopstools.ephemeris.sjd_ephemeris +.. autofunction:: lvmopstools.ephemeris.is_sun_up +.. autofunction:: lvmopstools.ephemeris.create_schedule + +InfluxDB +-------- + +.. autofunction:: lvmopstools.influxdb.query_influxdb + +PubSub +------ + +.. autoclass:: lvmopstools.pubsub.Publisher +.. autoclass:: lvmopstools.pubsub.Subscriber +.. autofunction:: lvmopstools.pubsub.send_event +.. autoclass:: lvmopstools.pubsub.Event +.. autoclass:: lvmopstools.pubsub.Message + Retrier ------- .. autoclass:: lvmopstools.retrier.Retrier :members: +Slack +----- + +.. automodule:: lvmopstools.slack + :members: + + Socket ------ .. autoclass:: lvmopstools.socket.AsyncSocketHandler :members: +Weather +------- + +.. automodule:: lvmopstools.weather + :members: + Devices ------- @@ -38,13 +72,13 @@ Ion Pumps .. autofunction:: lvmopstools.devices.ion.read_ion_pumps .. autofunction:: lvmopstools.devices.ion.toggle_ion_pump +NPS +^^^ + +.. autofunction:: lvmopstools.devices.nps.read_nps + Thermistors ^^^^^^^^^^^ .. autofunction:: lvmopstools.devices.thermistors.read_thermistors .. autofunction:: lvmopstools.devices.thermistors.channel_to_valve - -NPS -^^^ - -.. autofunction:: lvmopstools.devices.nps.read_nps diff --git a/src/lvmopstools/slack.py b/src/lvmopstools/slack.py index e921d7b..162b6b8 100644 --- a/src/lvmopstools/slack.py +++ b/src/lvmopstools/slack.py @@ -20,7 +20,7 @@ from lvmopstools import config -__all__ = ["post_message", "get_user_id"] +__all__ = ["post_message", "get_user_id", "get_user_list"] ICONS = {