Add Nitrokey Python SDK documentation

Nitrokey · Jul 26, 2024 · f21fb23 · f21fb23
1 parent 15375e2
commit f21fb23
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "nitrokey-sdk-py"]
+	path = nitrokey-sdk-py
+	url = https://github.com/Nitrokey/nitrokey-sdk-py.git
diff --git a/Makefile b/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

diff --git a/conf.py b/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'
diff --git a/nitrokey-sdk-py b/nitrokey-sdk-py
diff --git a/software/index.rst b/software/index.rst
@@ -7,3 +7,4 @@ Software
 
    nk-app2/index
    nitropy/index
+   ../nitrokey-sdk-py/docs/index