updated docs, RTD config, README, HISTORY and LICENSE

.github/workflows/release.yml

@@ -39,6 +39,7 @@ jobs:
           prWoLabels: true
           unreleased: true
           addSections: '{"documentation":{"prefix":"**Documentation:**","labels":["documentation"]}}'
+          sinceTag: v0.1.0
           output: CHANGELOG.md
 
       - uses: actions/setup-python@v2
@@ -55,12 +56,6 @@ jobs:
           poetry install -E doc
           poetry run mkdocs build
 
-      - name: publish documentation
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          personal_token: ${{ secrets.PERSONAL_TOKEN }}
-          publish_dir: ./site
-
       - name: Build wheels and source tarball
         run: >-
           poetry build

.readthedocs.yml

@@ -0,0 +1,12 @@
+version: 2
+
+python:
+  version: "3.8"
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false

HISTORY.md

@@ -1,5 +1,5 @@
 # History
 
-## 0.1.0 (2021-07-31)
+## 0.1.0 (2022-02-16)
 
 * First release on PyPI.

README.md

@@ -1,38 +1,88 @@
-# Netatmo GeoPy
-
+[![PyPI version fury.io](https://badge.fury.io/py/netatmo-geopy.svg)](https://pypi.python.org/pypi/netatmo-geopy/)
+[![Documentation Status](https://readthedocs.org/projects/netatmo-geopy/badge/?version=latest)](https://netatmo-geopy.readthedocs.io/en/latest/?badge=latest)
+[![CI/CD](https://github.com/martibosch/netatmo-geopy/actions/workflows/dev.yml/badge.svg)](https://github.com/martibosch/netatmo-geopy/blob/main/.github/workflows/dev.yml)
+[![codecov](https://codecov.io/gh/martibosch/netatmo-geopy/branch/main/graph/badge.svg?token=ZDFCCPJ6AK)](https://codecov.io/gh/martibosch/netatmo-geopy)
+[![GitHub license](https://img.shields.io/github/license/martibosch/netatmo-geopy.svg)](https://github.com/martibosch/netatmo-geopy/blob/main/LICENSE)
 
-<p align="center">
-<a href="https://pypi.python.org/pypi/netatmo_geopy">
-    <img src="https://img.shields.io/pypi/v/netatmo_geopy.svg"
-        alt = "Release Status">
-</a>
-
-<a href="https://github.com/martibosch/netatmo_geopy/actions">
-    <img src="https://github.com/martibosch/netatmo_geopy/actions/workflows/main.yml/badge.svg?branch=release" alt="CI Status">
-</a>
+# Netatmo GeoPy
 
-<a href="https://netatmo-geopy.readthedocs.io/en/latest/?badge=latest">
-    <img src="https://readthedocs.org/projects/netatmo-geopy/badge/?version=latest" alt="Documentation Status">
-</a>
 
-<a href="https://pyup.io/repos/github/martibosch/netatmo_geopy/">
-<img src="https://pyup.io/repos/github/martibosch/netatmo_geopy/shield.svg" alt="Updates">
-</a>
+Pythonic package to access Netatmo CWS data.
 
-</p>
+```python
+import netatmo_geopy as nat
 
+lon_sw, lat_sw, lon_ne, lat_ne = 6.5175, 46.5012, 6.7870, 46.6058
+cws_recorder = nat.CWSRecorder(lon_sw, lat_sw, lon_ne, lat_ne)
+gdf = cws_recorder.get_snapshot_gdf()
+gdf.head()
+```
 
-Pythonic package to access Netatmo CWS data
+<div>
+    <style scoped>
+     .dataframe tbody tr th:only-of-type {
+         vertical-align: middle;
+     }
 
+     .dataframe tbody tr th {
+         vertical-align: top;
+     }
 
-* Free software: GPL-3.0-only
-* Documentation: <https://netatmo-geopy.readthedocs.io>
+     .dataframe thead th {
+         text-align: right;
+     }
+    </style>
+    <table border="1" class="dataframe">
+        <thead>
+            <tr style="text-align: right;">
+                <th></th>
+                <th>2022-02-12T19:13</th>
+                <th>geometry</th>
+            </tr>
+            <tr>
+                <th>station_id</th>
+                <th></th>
+                <th></th>
+            </tr>
+        </thead>
+        <tbody>
+            <tr>
+                <th>02:00:00:01:5e:e0</th>
+                <td>6.6</td>
+                <td>POINT (6.82799 46.47089)</td>
+            </tr>
+            <tr>
+                <th>02:00:00:22:c0:c0</th>
+                <td>4.9</td>
+                <td>POINT (6.82904 46.47005)</td>
+            </tr>
+            <tr>
+                <th>02:00:00:2f:0b:16</th>
+                <td>3.5</td>
+                <td>POINT (6.82516 46.47294)</td>
+            </tr>
+            <tr>
+                <th>02:00:00:59:00:2a</th>
+                <td>3.8</td>
+                <td>POINT (6.84547 46.46779)</td>
+            </tr>
+            <tr>
+                <th>02:00:00:52:ed:5a</th>
+                <td>3.8</td>
+                <td>POINT (6.87359 46.47067)</td>
+            </tr>
+        </tbody>
+    </table>
+</div>
 
+```python
+nat.plot_snapshot(gdf)
+```
 
-## Features
+![lausanne-snapshot](https://github.com/martibosch/netatmo-geopy/blob/main/docs/figures/lausanne.png)
 
-* TODO
+See [the user guide](https://martibosch.github.io/netatmo-geopy/user-guide) for a more thorough overview of netatmo-geopy.
 
-## Credits
+## Acknowledgements
 
-This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [zillionare/cookiecutter-pypackage](https://github.com/zillionare/cookiecutter-pypackage) project template.
+* This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [zillionare/cookiecutter-pypackage](https://github.com/zillionare/cookiecutter-pypackage) project template.

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs==1.2.3
+mkdocs-include-markdown-plugin==1.0.0
+mkdocstrings==0.13.6