Skip to content

Commit

Permalink
docs: Update with new data submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroWave022 committed Oct 10, 2023
1 parent 3f83521 commit e454559
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 12 deletions.
16 changes: 8 additions & 8 deletions docs/locationforecast/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,34 @@ Locationforecast: API Reference
:undoc-members:
:show-inheritance:

.. autoclass:: yr_weather.locationforecast.Forecast
.. autoclass:: yr_weather.data.locationforecast.Forecast
:members:
:undoc-members:

.. autoclass:: yr_weather.locationforecast.ForecastTime
.. autoclass:: yr_weather.data.locationforecast.ForecastTime
:members:

.. autoclass:: yr_weather.locationforecast.ForecastFuture
.. autoclass:: yr_weather.data.locationforecast.ForecastFuture
:members:

Dataclasses
-----------
.. autoclass:: yr_weather.locationforecast.ForecastGeometry
.. autoclass:: yr_weather.data.locationforecast.ForecastGeometry
:members:
:undoc-members:

.. autoclass:: yr_weather.locationforecast.ForecastUnits
.. autoclass:: yr_weather.data.locationforecast.ForecastUnits
:members:
:undoc-members:

.. autoclass:: yr_weather.locationforecast.ForecastTimeDetails
.. autoclass:: yr_weather.data.locationforecast.ForecastTimeDetails
:members:
:undoc-members:

.. autoclass:: yr_weather.locationforecast.ForecastFutureSummary
.. autoclass:: yr_weather.data.locationforecast.ForecastFutureSummary
:members:
:undoc-members:

.. autoclass:: yr_weather.locationforecast.ForecastFutureDetails
.. autoclass:: yr_weather.data.locationforecast.ForecastFutureDetails
:members:
:undoc-members:
8 changes: 4 additions & 4 deletions docs/radar/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ Radar: API Reference
Dataclasses
-----------

.. autoclass:: RadarContentAvailable
.. autoclass:: yr_weather.data.radar.RadarContentAvailable
:members:
:undoc-members:

.. autoclass:: RadarOptions
.. autoclass:: yr_weather.data.radar.RadarOptions
:members:
:undoc-members:

.. autoclass:: RadarStatus
.. autoclass:: yr_weather.data.radar.RadarStatus
:members:
:undoc-members:

.. autoclass:: RadarGlobalStatus
.. autoclass:: yr_weather.data.radar.RadarGlobalStatus
:members:
:undoc-members:
27 changes: 27 additions & 0 deletions docs/sunrise/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,30 @@ Sunrise: API Reference
:members:
:undoc-members:
:show-inheritance:

Dataclasses
-----------

.. autoclass:: yr_weather.data.sunrise.SunEvents
:members:
:undoc-members:

.. autoclass:: yr_weather.data.sunrise.MoonEvents
:members:
:undoc-members:

.. autoclass:: yr_weather.data.sunrise.TimeWithElevation
:members:
:undoc-members:

.. autoclass:: yr_weather.data.sunrise.TimeWithAzimuth
:members:
:undoc-members:

.. autoclass:: yr_weather.data.sunrise.CommonEventsData
:members:
:undoc-members:

.. autoclass:: yr_weather.data.sunrise.EventsGeometry
:members:
:undoc-members:

0 comments on commit e454559

Please sign in to comment.