Repository navigation
Add docs site, benchmark script and PyPI release workflow - #18
Merged
Merged
Conversation
- MkDocs (Material + mkdocstrings) API docs from the docstrings, published with the JupyterLite notebooks (now under lite/) by one pages workflow - benchmarks/benchmark.py times steps for 1d/2d grids, both precisions and orders 2 and 4 - release workflow: builds and checks sdist and wheel on PRs, uploads to PyPI with trusted publishing when a GitHub release is published - version 0.5.0, CHANGELOG.md, PyPI metadata Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BSqcCcd888TDDSg17G2Hyu
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.
Requested by Alex · project thread
Item A6 of the next-steps plan.
Changes
docs/index.mdpulls in the README, and there is one API page per module. Math in the docstrings is rendered by MathJax.mkdocs build --strictpasses.jupyterlite.ymlbecomespages.yml. It builds the docs at the site root and JupyterLite underlite/, because GitHub Pages serves one site per repository.benchmarks/benchmark.pytimes steps for 1d and 2d grids. Columns are complex128 and complex64 at order 2, plus complex128 at order 4. Options are--quick,--pyfftw,--workers,--stepsand--repeat. Output with--quickhere:release.yml.twine check --strict.pypi). No token is stored in the repo.pyproject.tomland__init__.py.CHANGELOG.mdcovers everything since 0.4.0; the version notes that were in the README moved there.docsextra.pip install so_schroedinger, and short Documentation and Releases sections.One-time setup before the first release
so_schroedinger(the name is still free). Owneraeberspaecher, reposplitoperator, workflowrelease.yml, environmentpypi.v0.5.0.Tests
mkdocs build --strictis clean. I checked the rendered API pages in headless Chromium.python -m buildandtwine check --strictpass for both distributions.ruff checkandruff format --checkare clean.Generated by Claude Code