Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spacemanspiff2007 committed Sep 23, 2024
1 parent af90fa9 commit baeb222
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
45 changes: 45 additions & 0 deletions docs/rule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,51 @@ Job Control
:inherited-members:


Other scheduler related functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. py:currentmodule:: HABApp.rule.scheduler
Other scheduler related functions are available under ``HABApp.rule.scheduler``.

.. list-table::
:widths: auto
:header-rows: 1

* - Function
- Description

* - :meth:`~get_sun_position`
- Get azimuth and elevation of the sun.

* - :meth:`~is_holiday`
- Check if a date is a holiday.

* - :meth:`~add_holiday`
- Add a custom holiday

* - :meth:`~pop_holiday`
- Remove a holiday

* - :meth:`~get_holiday_name`
- Get the name of a holiday

* - :meth:`~get_holidays_by_name`
- Search holidays by name


.. autofunction:: get_sun_position

.. autofunction:: is_holiday

.. autofunction:: add_holiday

.. autofunction:: pop_holiday

.. autofunction:: get_holiday_name

.. autofunction:: get_holidays_by_name


Other tools and scripts
------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/HABApp/rule/scheduler/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from eascheduler.builder import FilterBuilder as filter
from eascheduler.builder import TriggerBuilder as trigger
from eascheduler import get_sun_position, is_holiday
from eascheduler import add_holiday, get_holiday_name, get_holidays_by_name, get_sun_position, is_holiday, pop_holiday

0 comments on commit baeb222

Please sign in to comment.