Add Nitrokey Python SDK documentation

.github/workflows/ci.yml

@@ -9,11 +9,13 @@ jobs:
   syntax-check:
     name: Check syntax
     runs-on: ubuntu-latest
-    container: python:3.11-slim
+    container: python:3.11
     continue-on-error: true
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          submodules: true
       - name: Create virtual environment
         run: |
           python -m venv venv
@@ -26,10 +28,12 @@ jobs:
   build-error-check:
     name: Check build error
     runs-on: ubuntu-latest
-    container: python:3.11-slim
+    container: python:3.11
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          submodules: true
       - name: Create virtual environment
         run: |
           python -m venv venv
@@ -38,4 +42,4 @@ jobs:
       - name: Build documentation
         run: |
           . venv/bin/activate
-          sphinx-build -W -j 1 -a -D language='en' -b html . __preview
+          sphinx-build -W -j 1 -a -D language='en' -b html . __preview

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "nitrokey-sdk-py"]
+	path = nitrokey-sdk-py
+	url = https://github.com/Nitrokey/nitrokey-sdk-py.git

Makefile

@@ -1,7 +1,7 @@
 
 
 all: __preview venv
-	. venv/bin/activate && sphinx-build -j auto -a -D language='en' -b html . __preview
+	. venv/bin/activate && pip install ./nitrokey-sdk-py && sphinx-build -j auto -a -D language='en' -b html . __preview
 
 watch:
 	while true; do inotifywait -e MODIFY `find . -name '*.rst'`; make; sleep 1; done

conf.py

@@ -39,6 +39,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx_copybutton',
@@ -435,3 +436,9 @@
 
 # Disables the closing of tabs if clicked on the currently active tab
 sphinx_tabs_disable_tab_closing = True
+
+# -- Options for autodoc extension -------------------------------------------
+
+autodoc_class_signature = 'separated'
+autodoc_member_order = 'groupwise'
+autodoc_typehints = 'description'

software/index.rst

@@ -7,3 +7,4 @@ Software
 
    nk-app2/index
    nitropy/index
+   ../nitrokey-sdk-py/docs/index