Skip to content

Release v0.2.2 — MkDocs documentation infrastructure#7

Merged
NanoBiostructuresRG merged 10 commits into
mainfrom
dev/v0.2.2
May 21, 2026
Merged

Release v0.2.2 — MkDocs documentation infrastructure#7
NanoBiostructuresRG merged 10 commits into
mainfrom
dev/v0.2.2

Conversation

@NanoBiostructuresRG

Copy link
Copy Markdown
Owner

Summary

Documentation infrastructure — no changes to source code, public API, or test suite.

Changes

  • MkDocs + Material theme + mkdocstrings setup
  • docs/index.md — home page
  • docs/api.md — auto-generated API reference from NumPy docstrings
  • docs/changelog.md — changelog page via snippets
  • mkdocs.yml — configuration with Material theme and mkdocstrings plugin
  • .github/workflows/docs.yml — auto-deploy to GitHub Pages on push to main
  • API.md removed — replaced by auto-generated docs
  • Documentation URL added to pyproject.toml

Checklist

  • 146 tests passing locally
  • CI green on Python 3.11 and 3.12
  • GitHub Pages source set to GitHub Actions

@NanoBiostructuresRG NanoBiostructuresRG merged commit b2b8ceb into main May 21, 2026
4 checks passed
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