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

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

Add API documentation #15

wants to merge 1 commit into from

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

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.

1 participant