Merge pull request #157 from zabuldon/dev

Signed-off-by: Alan Tse <alandtse@gmail.com>

.github/workflows/semantic_release.yml

@@ -21,6 +21,9 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install python-semantic-release
+      - name: Make documentation
+        run: |
+          make docs
       - name: Setup Git
         run: |
           git config --global user.name "semantic-release"

Makefile

@@ -25,3 +25,7 @@ test:
 	pipenv run pytest -s --verbose tests -Wi -Wd:::teslajsonpy
 typing:
 	pipenv run mypy --ignore-missing-imports teslajsonpy
+docs: docstyle
+	pipenv lock -r --dev > docs/requirements.txt
+	echo "teslajsonpy" >> docs/requirements.txt
+	pipenv run sphinx-build -b html docs docs/html

Pipfile

@@ -16,13 +16,19 @@ tox-pipenv = "*"
 twine = "*"
 black = "*"
 typing-extensions = "*"
+sphinx = "*"
+autoapi = "*"
+sphinx-rtd-theme = "*"
+m2r2 = "*"
+sphinx-autoapi = "*"
+sphinx-copybutton = "*"
 
 [packages]
 aiohttp = "*"
 backoff = "*"
 beautifulsoup4 = "*"
 wrapt = "*"
-authcaptureproxy = "0.4.0"
+authcaptureproxy = "~=0.4.2"
 
 [pipenv]
 allow_prereleases = true

docs/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. teslajsonpy documentation master file, created by
+   sphinx-quickstart on Sat Feb 13 23:32:50 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to teslajsonpy's documentation!
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`