[Project] Add python docs deployment (#15)

.github/workflows/docs.yml

@@ -10,6 +10,8 @@ on:
 
 jobs:
   build:
+    # Do not attempt to deploy documentation on forks
+    if: github.repository_owner == 'JetBrains-Research'
     runs-on: ubuntu-latest
 
     steps:
@@ -23,3 +25,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./html/
+          destination_dir: cdocs

.github/workflows/pydocs.yml

@@ -0,0 +1,39 @@
+name: Python docs
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - '.github/**'
+      - 'python/pyspbla/**'
+
+jobs:
+  documentation:
+    # Do not attempt to deploy documentation on forks
+    if: github.repository_owner == 'JetBrains-Research'
+    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: Install packages
+        run: python -m pip install pdoc3
+
+      - name: Build docs
+        run: pdoc -o pydocs --html python/pyspbla
+        env:
+          SPBLA_DOCS_ONLY: true
+
+      - name: Publish to Github Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./pydocs/
+          destination_dir: pydocs

README.md

@@ -15,11 +15,11 @@ library features and primitives in high-level format with automated resources ma
 
 * **PyPI package:** [https://pypi.org/project/pyspbla/](https://pypi.org/project/pyspbla/)
 * **Tutorial:** [https://github.com/JetBrains-Research/spbla/blob/main/docs/tutorial.md](https://github.com/JetBrains-Research/spbla/blob/main/docs/tutorial.md)
-* **Getting started:** [https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md](https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md)
 * **Extended example:** [https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md](https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md)
+* **Getting started:** [https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md](https://github.com/JetBrains-Research/spbla/blob/main/docs/getting_started.md)
 * **Contributing guide:** [https://github.com/JetBrains-Research/spbla/blob/master/CONTRIBUTING.md](https://github.com/JetBrains-Research/spbla/blob/master/CONTRIBUTING.md)
-* **Python Reference:**
-* **C API Reference:** [https://jetbrains-research.github.io/spbla/](https://jetbrains-research.github.io/spbla/)
+* **Python Reference:** [https://jetbrains-research.github.io/spbla/pydocs/pyspbla](https://jetbrains-research.github.io/spbla/pydocs/pyspbla)
+* **C API Reference:** [https://jetbrains-research.github.io/spbla/cdocs/](https://jetbrains-research.github.io/spbla/cdocs/)
 * **Package source code:** [https://github.com/JetBrains-Research/spbla/tree/main/python/pyspbla](https://github.com/JetBrains-Research/spbla/tree/main/python/pyspbla)
 
 ### Features summary
@@ -42,6 +42,15 @@ library features and primitives in high-level format with automated resources ma
 
 - Linux based OS (tested on Ubuntu 20.04)
 
+
+### Installation
+
+Get the latest package version from PyPI package index:
+
+```shell
+$ python3 -m pip install pyspbla
+```
+
 ### Simple example
 
 Create sparse matrices, compute matrix-matrix product and print the result to the output:

python/pyspbla/wrapper.py

@@ -46,6 +46,12 @@ def __init__(self):
         self.loaded_dll = None
         self.backend = "default"
 
+        try:
+            if os.environ["SPBLA_DOCS_ONLY"]:
+                return
+        except KeyError:
+            pass
+
         try:
             # Try from config if present
             self.load_path = os.environ["SPBLA_PATH"]
@@ -74,8 +80,9 @@ def __setup_library(self):
         bridge.check(status)
 
     def __release_library(self):
-        status = self.loaded_dll.spbla_Finalize()
-        bridge.check(status)
+        if self.loaded_dll is not None:
+            status = self.loaded_dll.spbla_Finalize()
+            bridge.check(status)
 
     @classmethod
     def __get_lib_path(cls, prefix):