Repository navigation
📝 docs: add a Zensical site deployed to GitHub Pages - #81
Merged
Merged
Conversation
Home page is the README (via snippets, with GitHub callouts rendered as admonitions); the API page is generated by mkdocstrings. The Docs workflow builds on every PR and deploys from main. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #81 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 3
Lines ? 75
Branches ? 0
========================================
Hits ? 75
Misses ? 0
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Adds a Zensical docs site, published to GitHub Pages at https://galacticdynamics.github.io/xmmutablemap. The setup follows
nstarman/quax.Changes
mkdocs.yml: Material theme with a light/dark toggle, using the repo'sfavicon.svgas the logo.docs/index.mdpulls inREADME.mdwithpymdownx.snippets, so the README remains the only source.github-callouts(frommarkdown-callouts) renders the README's> [!WARNING]alert as a warning admonition.docs/api.mddocumentsImmutableMapandfrozendictwith mkdocstrings, usingdocstring_style: numpyto match the docstrings.pyproject.toml: a newdocsdependency group, also included indev, withuv.lockupdated..github/workflows/docs.yml: builds on every PR and onworkflow_dispatch. Onmainit uploads the Pages artifact and deploys withactions/deploy-pages. The concurrency group matchesci.yml(👷 ci: key main's concurrency group on push events only #78), so deploys from separate merges don't cancel each other. quax's workflow builds twice; this one builds once and uploads conditionally.Pages is already set to deploy from GitHub Actions in the repo settings, so the first merge to
mainshould publish the site.Verification
uv sync --no-default-groups --group docs --locked && zensical build --cleanreports no issues.prek run --all-filespasses andpytestpasses (116 tests).To preview locally:
uv run --group docs zensical serve🤖 Generated with Claude Code