Repository navigation
Documentation site (MkDocs Material + GitHub Pages) - #7
Merged
Merged
Conversation
- 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
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
Adds a documentation website, to be published at https://rasidi3112.github.io/quantum-simulation/.
benchmarks/validation_report.mddirectly, so it cannot drift from the suite.docs.yml:mkdocs build --stricton every pull request (warnings fail the build), and deployment to GitHub Pages on pushes tomain.images/at build time, so nothing is duplicated in the repository.docsextra pinsmkdocs<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
mainfails.Test plan
mkdocs build --strictlocally: no warnings or info messagespytest: 118 passed, 12 skipped (CUDA-only)docsandtestsworkflows on this PR