Skip to content

Conversation

@robin-nitrokey
Copy link
Member

Fixes: #329

@robin-nitrokey
Copy link
Member Author

robin-nitrokey commented Nov 26, 2024

There are three options for fetching the SDK documentation:

  1. Use a submodule (current implementation). Advantages: reproducible builds. Disadvantages: higher maintenance, uses submodules.
  2. Use and download a pinned tag. Advantages: reproducible builds. Disadvantages: higher maintenance.
  3. Always use the latest tag from GitHub. Advantages: reduced maintenance. Disadvantages: SDK releases can break the docs build.

I would vote for 1 or 2 to keep the build reproducible. 2. would be a manual way of re-implementing submodules, so my preferred option is 1.

@daringer
Copy link
Contributor

can we please not have a submodule - download or checkout a tag?

@robin-nitrokey robin-nitrokey force-pushed the nitrokey-sdk-py branch 2 times, most recently from 2364f41 to 72fffb2 Compare November 29, 2024 10:50
@robin-nitrokey
Copy link
Member Author

Updated to download the SDK from a tag. We need to maintain a symlink to the downloaded SDK, but I did not find a way to avoid that.

@daringer
Copy link
Contributor

can you please rebase - then we should get a preview

@github-actions
Copy link

The successful documentation build was deployed for preview:

@robin-nitrokey
Copy link
Member Author

Would be good to also have the version displayed somewhere but I don’t see an option to automatically include it.

@robin-nitrokey
Copy link
Member Author

Looks like we could read out the version in conf.py using Python code and then define a RST directive to insert the version string.

@daringer
Copy link
Contributor

looks pretty good for me, should we merge as is ?

@github-actions
Copy link

The successful documentation build was deployed for preview:

@robin-nitrokey robin-nitrokey merged commit 40dc51f into main Jan 28, 2025
2 checks passed
@robin-nitrokey robin-nitrokey deleted the nitrokey-sdk-py branch January 28, 2025 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Nitrokey Python SDK documentation

3 participants