Add API docs built with mkdocs and deployed to GitHub Pages - #32
Merged
Conversation
- mkdocs + Material theme + mkdocstrings render valentbind's docstrings into a browsable API reference, plus a landing page with install/usage instructions. - .github/workflows/docs.yml builds the site with `mkdocs build --strict` and deploys it to GitHub Pages via the official upload-pages-artifact/deploy-pages actions on every push to main. - Add mkdocs, mkdocs-material, and mkdocstrings[python] to the dev dependency group.
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mkdocs+ Material theme +mkdocstringsto rendervalentbind's docstrings into a browsable API reference (docs/api.md), plus a landing page (docs/index.md) with install/usage instructions..github/workflows/docs.ymlbuilds the site withmkdocs build --stricton every push tomainand deploys it to GitHub Pages via the officialupload-pages-artifact/deploy-pagesactions.build_type: workflow(via the API) so this workflow has somewhere to publish to — site will be live at https://meyer-lab.github.io/valentBind/ once this merges and the workflow runs onmain.:param:/:return:docstrings land, sincemkdocstringsis configured for that style.Test plan
uv run mkdocs build --strictsucceeds with no warningsuv run ruff check ./uv run ruff format --check .passuv run pyteststill passes