Skip to content

Commit

Permalink
added new theme
Browse files Browse the repository at this point in the history
  • Loading branch information
suvanbanerjee committed Apr 9, 2024
1 parent b338602 commit f714521
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ jobs:
with:
python-version: 3.x
- run: pip install mkdocs
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force --clean --verbose
3 changes: 1 addition & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

## Getting Started
# Getting Started

The easy way to get WeatherKit is from pip:

Expand Down
10 changes: 5 additions & 5 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Usage

### Current Weather
## Current Weather

Current weather can be accessed by creating an object of the `current_weather` class. The object can be created by providing the city name or the latitude and longitude of the location. The object provides the following methods to get the weather details:
#### Sample usage providing city name
### Sample usage providing city name

```python
import weatherkit
Expand All @@ -20,7 +20,7 @@ print(NYC.precipitation())
# Output: 0.0
```

#### Sample usage providing latitude and longitude
### Sample usage providing latitude and longitude

```python
import weatherkit
Expand All @@ -36,7 +36,7 @@ print(NYC.weather_code())
print(NYC.precipitation())
# Output: 0.0
```
### Daily Forecast
## Daily Forecast

Daily forecast can be accessed by creating an object of the `daily_forecast` class. The object can be created by providing the city name or the latitude and longitude of the location. The object provides the following methods to get the weather details:

Expand Down Expand Up @@ -64,7 +64,7 @@ print(NYC.weather_code())
print(NYC.weather_code(day_offset=3))
# Output: 3
```
#### Note
### Note
- Similar to current weather, daily forecast can also be used by providing latitude and longitude.

- day_offset is the number of days from today for which the forecast is required. day_offset=0 (which is default) will give the forecast for today, day_offset=1 will give the forecast for tomorrow and so on.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ nav:
- "Getting Started": getting-started.md
- "Usage": usage.md
- "Contribute": contribute.md
theme: readthedocs
theme: material

0 comments on commit f714521

Please sign in to comment.