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.

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

Add API documentation #15

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Add API documentation #15

merged 1 commit into from
Sep 25, 2024

Conversation

robin-nitrokey
Copy link
Member

@robin-nitrokey robin-nitrokey commented Jul 25, 2024

To do:

  • Review module structure #9 so that we have less module pages with more content
  • rename all module pages to only the module name
  • remove unnecessary subsections
  • remove package/module distinction
  • consider moving api/nitrokey.rst into api/index.rst
  • add more doc strings
  • add usage guide
  • add docs checks to CI

@robin-nitrokey
Copy link
Member Author

Marking as ready for review – we still have virtually no doc strings, but I think that should not block the documentation infrastructure.

@robin-nitrokey robin-nitrokey marked this pull request as ready for review September 25, 2024 10:42
@robin-nitrokey
Copy link
Member Author

See this PR to build and preview the SDK docs as part of nitrokey-documentation: Nitrokey/nitrokey-documentation#269

@robin-nitrokey robin-nitrokey merged commit 4fa7307 into main Sep 25, 2024
26 checks passed
@robin-nitrokey robin-nitrokey deleted the docs branch September 25, 2024 18:19
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.

2 participants