From 059614b70e28f6743f64ccc4859a34fd7f348bf7 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Thu, 25 Jul 2024 13:05:01 +0200 Subject: [PATCH] Add Nitrokey Python SDK documentation --- .gitmodules | 3 +++ Makefile | 2 +- conf.py | 1 + nitrokey-sdk-py | 1 + software/index.rst | 1 + 5 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 nitrokey-sdk-py diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000..7554761a5c --- /dev/null +++ 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 index 79ecb6354d..14aca7f3c2 100644 --- 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 index 1c1a834fe5..027ac0c0a8 100644 --- 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', diff --git a/nitrokey-sdk-py b/nitrokey-sdk-py new file mode 160000 index 0000000000..62ae235bec --- /dev/null +++ b/nitrokey-sdk-py @@ -0,0 +1 @@ +Subproject commit 62ae235bec5e3c5b7205e906c9db812d5c1cc2d0 diff --git a/software/index.rst b/software/index.rst index 2fc32150d5..1cf7649483 100644 --- a/software/index.rst +++ b/software/index.rst @@ -7,3 +7,4 @@ Software nk-app2/index nitropy/index + ../nitrokey-sdk-py/docs/index