docs: add sphinx support

zabuldon · Feb 14, 2021 · 483ddd0 · 483ddd0
1 parent b64602a
commit 483ddd0
Show file tree

Hide file tree

Showing 147 changed files with 42,636 additions and 25 deletions.
diff --git a/.github/workflows/semantic_release.yml b/.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"

diff --git a/Makefile b/Makefile
@@ -25,3 +25,5 @@ test:
 	pipenv run pytest -s --verbose tests -Wi -Wd:::teslajsonpy
 typing:
 	pipenv run mypy --ignore-missing-imports teslajsonpy
+docs: docstyle
+	pipenv run sphinx-build -b html docs docs/html
diff --git a/Pipfile b/Pipfile
@@ -16,6 +16,10 @@ tox-pipenv = "*"
 twine = "*"
 black = "*"
 typing-extensions = "*"
+sphinx = "*"
+autoapi = "*"
+sphinx-rtd-theme = "*"
+m2r2 = "*"
 
 [packages]
 aiohttp = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/_sources/index.rst.txt b/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`