Skip to content

Commit

Permalink
Update docs API section
Browse files Browse the repository at this point in the history
  • Loading branch information
albireox committed Dec 22, 2024
1 parent b6de4ed commit 9c7feb4
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 6 deletions.
44 changes: 39 additions & 5 deletions docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand All @@ -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
2 changes: 1 addition & 1 deletion src/lvmopstools/slack.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from lvmopstools import config


__all__ = ["post_message", "get_user_id"]
__all__ = ["post_message", "get_user_id", "get_user_list"]


ICONS = {
Expand Down

0 comments on commit 9c7feb4

Please sign in to comment.