chore: add GitHub Actions for deploying docs (#399)

Automatically update the documentation when a release is made.

Co-authored-by: Saurabh Kumar <theskumar@noreply.users.github.com>

.github/workflows/release.yml

@@ -23,3 +23,9 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
         make release
+
+    - name: Publish Documentation
+      run: |
+        pip install -r requirements-docs.txt
+        pip install -e .
+        mkdocs gh-deploy --force

CONTRIBUTING.md

@@ -20,7 +20,7 @@ or with [tox](https://pypi.org/project/tox/) installed:
 Documentation is published with [mkdocs]():
 
 ```shell
-$ pip install -r requirements.txt
+$ pip install -r requirements-docs.txt
 $ pip install -e .
 $ mkdocs serve
 ```

MANIFEST.in

@@ -9,4 +9,5 @@ include .coveragerc
 include .editorconfig
 include Makefile
 include requirements.txt
+include requirements-docs.txt
 include src/dotenv/py.typed

requirements-docs.txt

@@ -0,0 +1,5 @@
+mdx_truly_sane_lists~=1.2
+mkdocs-include-markdown-plugin~=3.3.0
+mkdocs-material~=8.2.9
+mkdocstrings[python]~=0.18.1
+mkdocs~=1.3.0

requirements.txt

@@ -3,11 +3,6 @@ bumpversion
 click
 flake8>=2.2.3
 ipython
-mdx_truly_sane_lists~=1.2
-mkdocs-include-markdown-plugin~=3.3.0
-mkdocs-material~=8.2.9
-mkdocstrings[python]~=0.18.1
-mkdocs~=1.3.0
 pytest-cov
 pytest>=3.9
 sh>=1.09