Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Nitrokey Python SDK documentation #334

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Nitrokey Python SDK documentation #334

wants to merge 1 commit into from

Conversation

robin-nitrokey
Copy link
Member

Fixes: #329

@robin-nitrokey
Copy link
Member Author

robin-nitrokey commented Nov 26, 2024 •
edited
Loading

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daringer daringer Awaiting requested review from daringer

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Nitrokey Python SDK documentation
2 participants
@robin-nitrokey @daringer