Skip to content

Documentation site (MkDocs Material + GitHub Pages) - #7

Merged
rasidi3112 merged 1 commit into
mainfrom
feat/docs-site
Oct 24, 2026
Merged

rasidi3112 merged 1 commit into
mainfrom
feat/docs-site

Conversation

@rasidi3112

Copy link
Copy Markdown
Owner

Summary

Adds a documentation website, to be published at https://rasidi3112.github.io/quantum-simulation/.

  • User guide: time evolution (orders, time-dependent potentials, GPE, rotation, damping, callbacks), stationary states, the potential registry, observables, 3D visualization, GPU acceleration with the measured T4 results, and the YAML runner.
  • Examples gallery: examples 01–11 with their figures and validation results.
  • Validation page: includes benchmarks/validation_report.md directly, so it cannot drift from the suite.
  • API reference: generated from the docstrings with mkdocstrings (NumPy style).
  • Workflow docs.yml: mkdocs build --strict on every pull request (warnings fail the build), and deployment to GitHub Pages on pushes to main.
  • Figures are copied from images/ at build time, so nothing is duplicated in the repository.
  • The docs extra pins mkdocs<2, because MkDocs 2.0 removes the plugin system that Material and mkdocstrings rely on.

Before merging

GitHub Pages must be enabled with Source: GitHub Actions. Otherwise the first deploy on main fails.

Test plan

  • mkdocs build --strict locally: no warnings or info messages
  • All 19 pages checked in a browser: 18 images and 11 internal links resolve, API parameter tables parse correctly
  • pytest: 118 passed, 12 skipped (CUDA-only)
  • docs and tests workflows on this PR

- user guide (time evolution, stationary states, potentials,
  observables, visualization, GPU, YAML runner), examples gallery,
  validation page that includes benchmarks/validation_report.md, and
  citation/license page
- API reference generated from the docstrings with mkdocstrings
- docs workflow: strict build on every pull request, deploy to GitHub
  Pages on pushes to main; figures are copied from images/ at build time
  instead of being duplicated in the repository
- docs extra pins mkdocs<2, whose 2.0 release drops the plugin system
- README: docs badge and link
@rasidi3112
rasidi3112 merged commit 5d52a7e into main Oct 24, 2026
8 checks passed
@rasidi3112
rasidi3112 deleted the feat/docs-site branch October 24, 2026 07:40
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