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 #321

Closed
wants to merge 705 commits into from
Closed

Add Nitrokey Python SDK documentation #321

wants to merge 705 commits into from

Conversation

robin-nitrokey
Copy link
Member

  • The nitrokey package needs to be installed to build the documentation. I’ve added it to the Dockerfile for now, but there should probably be a build script instead to make sure both are in sync.
  • Currently, we pin a SDK version with a Git submodule. Instead we could also try to use the latest release from GitHub.

Sphinx (docstest) and others added 30 commits October 8, 2024 10:22
Language Files generated by Sphinx
a77c2a9
@weblate
Translated using Weblate (German)
88b661e 
Currently translated at 37.5% (1460 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
c45e5d6 
Currently translated at 37.5% (1461 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@brueckner
Exclude queue and lock files from repo
77984f7
@weblate
Translated using Weblate (German)
634167f 
Currently translated at 37.6% (1462 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
5cadaf9 
Currently translated at 37.6% (1463 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
b78d735 
Currently translated at 37.6% (1464 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
b3566bc 
Currently translated at 37.6% (1465 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
5f7db5f 
Currently translated at 37.7% (1466 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
a616ac2 
Currently translated at 37.7% (1467 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
de54f87 
Currently translated at 37.7% (1468 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
01279dc 
Currently translated at 37.7% (1469 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
a4376db 
Currently translated at 37.8% (1470 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@brueckner
Trigger queue after running the build script
8d5c7aa
@weblate
Translated using Weblate (German)
6748b3b 
Currently translated at 37.8% (1471 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
79a18a1 
Currently translated at 37.8% (1472 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
5d3c236 
Currently translated at 37.8% (1473 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
02008a3 
Currently translated at 37.9% (1474 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
f9f7f01 
Currently translated at 37.9% (1475 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
ee17520 
Currently translated at 37.9% (1476 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
44f656e 
Currently translated at 37.9% (1477 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
84a81e4 
Currently translated at 38.0% (1478 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
9fb6c08 
Currently translated at 38.0% (1479 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
ecd9ce3 
Currently translated at 38.0% (1480 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
5fc516b 
Currently translated at 38.1% (1481 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
1d5c1da 
Currently translated at 38.1% (1482 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
a788694 
Currently translated at 38.1% (1483 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@weblate
Translated using Weblate (German)
cfa1609 
Currently translated at 38.1% (1484 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@brueckner
Simplify queue file
c0dc6c4
@weblate
Translated using Weblate (German)
e087d68 
Currently translated at 38.2% (1485 of 3887 strings)

Co-authored-by: dotplex <[email protected]>
Translate-URL: http://docstest-weblate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
daringer and others added 24 commits November 11, 2024 13:19
@daringer
openpgp-card: fix change-pins image locations
be2ff06
@daringer
fix more paths
1cdeb3e
@daringer
#314: features/u2f remove pro2 from compatibility
c86e88b
@daringer
#314: remove reference to update.nitrokey.com
fa24c6e
@daringer
#314: update totp to also list nk3 and add a note to use nk-app2
85ca818
@daringer
#314: move adsk to nks/features
57f1a60
@daringer
Merge pull request #309 from Nitrokey/nk-refactor
d297d7a 
nitrokeys: remove redundancies; cleanups; feature-based structure
Language Files generated by Sphinx
ba26b09
@weblate
Translated using Weblate (Spanish)
254a01b 
Currently translated at 100.0% (3760 of 3760 strings)

Translated using Weblate (Estonian)

Currently translated at 100.0% (3760 of 3760 strings)

Translated using Weblate (German)

Currently translated at 96.9% (3856 of 3979 strings)

Co-authored-by: DeepL <[email protected]>
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/es/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/et/
Translation: Nitrokey Documentation/Components
@jans23
Update faq.rst
ffc4137
Language Files generated by Sphinx
e4e57f2
@weblate
Translated using Weblate (Finnish)
464e4cb 
Currently translated at 100.0% (3759 of 3759 strings)

Translated using Weblate (Hungarian)

Currently translated at 100.0% (3759 of 3759 strings)

Translated using Weblate (Swedish)

Currently translated at 100.0% (3759 of 3759 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (3759 of 3759 strings)

Translated using Weblate (Chinese (Simplified Han script))

Currently translated at 100.0% (3759 of 3759 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (3759 of 3759 strings)

Co-authored-by: DeepL <[email protected]>
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/fi/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/hu/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/pl/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/ru/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/sv/
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/zh_Hans/
Translation: Nitrokey Documentation/Components
@jans23
Typo in administration.rst
907de7d
Language Files generated by Sphinx
a6699d7
@brueckner
Fix github links
48ff40a
@brueckner
Fix github links
9e79969
@jpmens
ssh -I needs library only (#317)
2db9119 
Option `-I` to `ssh` requires specifying the shared library and not the string `PKCS11Provider`.
Language Files generated by Sphinx
598f970
@jans23
Update UDEV path (#319)
e1aa39d
Language Files generated by Sphinx
34c2151
@jans23
PIV troubleshooting (#320)
977a61f 
* PIV troubleshooting

* nitropy PIV feature

* Link to shop fixed
Language Files generated by Sphinx
77bf107
@weblate
Translated using Weblate (German)
961d4b8 
Currently translated at 96.7% (3860 of 3990 strings)

Co-authored-by: DeepL <[email protected]>
Translate-URL: http://translate.nitrokey.com/projects/nitrokey-documentation/components/de/
Translation: Nitrokey Documentation/Components
@robin-nitrokey
Add Nitrokey Python SDK documentation
61af949
@robin-nitrokey robin-nitrokey mentioned this pull request Nov 14, 2024
Closed
3 tasks
@daringer
Copy link
Contributor

It might be that I said something else before - but I'd maybe prefer a release download instead of a submodule

@robin-nitrokey
Copy link
Member Author

Sure, but let’s first make sure that it’s working at all. Then we can change the details.

@daringer daringer closed this Nov 25, 2024
@robin-nitrokey robin-nitrokey mentioned this pull request Nov 25, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@robin-nitrokey @daringer @brueckner @jans23 @mmerklinger @jpmens