Repository navigation
Documentation site (MkDocs, GitHub Pages) with a JupyterLite demo - #57
Merged
Merged
Conversation
- mkdocs.yml, docs/: MkDocs Material site, as for PowerFit. The pages include sections of README.md, INSTALLATION.md, CONTRIBUTING.md and test-cases/README.md (--8<-- markers), so nothing is duplicated. - Manual with a recommended workflow and the web service; CLI reference generated from the arguments; the reports of the CPU reference results. - JupyterLite notebook that runs DisVis in the browser with a WebAssembly wheel built from the source, and shows the report. - docs extra, docs/Makefile and .github/workflows/pages.yml (deploys from main). - README: link to the site; absolute links to aidecl.yaml and CHANGELOG.md. Closes #50 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What does this PR do and why?
Adds a documentation site, https://www.bonvinlab.org/disvis, built with MkDocs Material and deployed to GitHub Pages, as for PowerFit and WHISCY.
README.md,INSTALLATION.md,CONTRIBUTING.mdandtest-cases/README.md(between<!-- --8<-- [start:x] -->markers, invisible on GitHub and PyPI), so nothing is duplicated.disvisarguments (mkdocs-rich-argparse); the example page links the reports of the CPU reference results (Write an HTML report with a Mol* view (--no-report to turn it off) #49).pypi-publish.yml, since the 3.0.0 wheel on PyPI has no report.docsextra,docs/Makefile(make -C docs,make -C docs serve) and.github/workflows/pages.yml(builds on PRs, deploys frommain).aidecl.yamlandCHANGELOG.mdare now absolute (they were broken on PyPI).CONTRIBUTING.mdexplains how to build the site.How was this tested?
make -C docsfrom a clean state: wheel,mkdocs build --strict, JupyterLite.cpu/coarse.Not tested: the Pages workflow on GitHub (this PR runs its build job), and the deployment.
AI assistance
Written with Claude Code; checked as above.
Checklist
README.md,INSTALLATION.md)test-cases/*/example-results/updated if the output changes (output unchanged)Related issues
Closes #50
Notes for reviewers
jupyterlite-pyodide-kernel==0.8.7andcibuildwheel==4.3.5are pinned together: the Pyodide ABI of the wheel (2026_0) must match that of the JupyterLite kernel. PowerFit pins only the build side.docs/test-casesis a symlink totest-cases/(as WHISCY linksexample/), so the site can serve the example reports.🤖 Generated with Claude Code