📝 publish documentation to pages (#84)

Author: ianardee

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+#
+# Publish Documentation to GitHub pages.
+#
+name: Documentation
+
+on:
+  - push:
+      tags:
+        - v**
+
+jobs:
+  static-check:
+    name: Publish Documentation
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-docs-${{ hashFiles('setup.cfg') }}
+        restore-keys: |
+          ${{ runner.os }}-docs-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install pip
+        pip install -e .[docs]
+
+    - name: Sphinx make
+      run: |
+        cd ./docs
+        make html
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html

.github/workflows/linting.yml

@@ -25,9 +25,9 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-dev-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ${{ runner.os }}-pip-
+          ${{ runner.os }}-dev-
 
     - name: Install dependencies
       # We install the full dev requirements to make sure everything installs OK

docs/.nojekyll

@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Python Client"
+project = "Mindee Python Client"
 copyright = "2022, Mindee"
 author = "Mindee"