Skip to content

feat: add docs, rename sdk submodule -> core #32

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

Merged
merged 7 commits into from
Sep 13, 2024
Merged

feat: add docs, rename sdk submodule -> core #32

merged 7 commits into from
Sep 13, 2024

Conversation

alkasm
Copy link
Contributor

@alkasm alkasm commented Sep 13, 2024

Rename the sdk module to a more standard name: core

Add docs:

  • using mkdocs, which transforms markdown -> html
  • using mkdocs material theme, which looks substantially better
  • using mkdocstrings-python to autogenerate nominal package docs from python docstrings
  • using mkdocs-click to autogenerate docs for the nom cli
  • needed to make some small code and organization modifications to make the docs clearer

@alkasm alkasm changed the title Add docs feat: add docs, rename sdk submodule -> core Sep 13, 2024
@alkasm alkasm merged commit 77ff5e0 into main Sep 13, 2024
6 of 7 checks passed
@alkasm alkasm deleted the alkasm/docs branch September 13, 2024 15:19
This was referenced Oct 9, 2024
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