Ozon3Org / Ozon3

An open-source Python package to easily obtain real-time, historical, or forecasted air quality data for anywhere in the world. Reliable, accurate and simple.
GNU General Public License v3.0
66 stars 24 forks source link

Add documentation for `get_historical_data`, `get_city_station_options`, and `get_city_forecast` to the gh-pages documentation #107

Closed Milind220 closed 2 years ago

Milind220 commented 2 years ago

The methods page of the official API documentation explains every public method in Ozone and shows how it can be used.

Three new methods have been added, for which there is no complete documentation right now:

Milind220 commented 2 years ago

Hold my beer, I got this

Milind220 commented 2 years ago

I'm going to make these changes directly in the gh-pages branch. In methods section:

Milind220 commented 2 years ago

I've been thinking about documentation for Ozone, and I think perhaps GitHub pages wasn't the best choice for this. It requires too much baby-sitting to update for each method. I'm going to look into some automatic documentation generators, that could use our method docstrings to generate documentation.