Merge pull request #38 from dhhagan/dhhagan-feature-docs

Add examples and docs

.github/workflows/deploy-docs.yml

@@ -0,0 +1,39 @@
+name: docs/gh-pages
+on: [workflow_dispatch]
+
+jobs:
+    build-docs:
+        name: Build the docs and push to github pages
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout branch
+              uses: actions/checkout@v2
+
+            - name: Setup Python
+              uses: actions/setup-python@master
+              with:
+                python-version: 3.8
+
+            - name: Install poetry
+              uses: snok/install-poetry@v1
+              with:
+                virtualenvs-create: true
+
+            - name: Install dependencies
+              run: poetry install --no-interaction
+
+            - name: build docs
+              run: |
+                source $(poetry env info --path)/bin/activate
+                cd docs
+                make clean
+                make notebooks html
+                cd ..
+
+            - name: deploy to gh-pages
+              uses: Cecilapp/GitHub-Pages-deploy@v3
+              env:
+                GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+              with:
+                email: [email protected]
+                build_dir: docs/_build/html

README.md

@@ -1,9 +1,8 @@
 # atmospy: air quality data visualization
 
 
-<!-- [![PyPI version](https://badge.fury.io/py/quantaq-cli.svg)](https://badge.fury.io/py/atmospy) -->
-<!-- ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/atmospy)
-[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/quant-aq/atmospy/blob/master/LICENSE) -->
+[![PyPI version](https://badge.fury.io/py/atmospy.svg)](https://badge.fury.io/py/atmospy)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/atmospy)
 [![Tests](https://github.com/dhhagan/atmospy/actions/workflows/tests.yml/badge.svg)](https://github.com/dhhagan/atmospy/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/dhhagan/atmospy/branch/main/graph/badge.svg)](https://codecov.io/gh/dhhagan/atmospy)
 ![Apache 2.0 licensed](https://img.shields.io/github/license/dhhagan/atmospy)

atmospy/__init__.py

@@ -8,7 +8,6 @@
 
 from .utils import *
 from .rcmod import *
-from .calendar import *
 from .relational import *
 from .trends import *
 from .rose import *