Skip to content

DOC/CI(examples): add reproducible tutorials and documentation builds - #16

Merged
mj-will merged 3 commits into
mainfrom
docs-build
Oct 15, 2026
Merged

mj-will merged 3 commits into
mainfrom
docs-build

Conversation

@mj-will

@mj-will mj-will commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

No description provided.

Move tracked scripts and their narratives together under examples/.
Preserve local outputs and pre-existing untracked examples without adding them.
Apply the import and formatting fixes required by Ruff to the moved CuPy script.
Add Pixi environments, an explicit execution manifest, isolated example runs,
and checksummed output bundles with source and dependency provenance. Resolve
Sequince main once per execution batch and archive that batch's lock for rebuilds.

Organize Sphinx tutorials from Gaussian and Rosenbrock through advanced methods,
with inline figures and script downloads. Keep numerical summaries in bundles.
Add local Make targets and regression tests for adapters and provenance checks.

Preserve sampling settings and seeds. Optional documentation exports add no
sampler RNG calls. Full numerical runs remain unvalidated for the new adapters;
worker and page-layout checks use mocks or explicitly marked plot fixtures.
Run examples in parallel using one resolved Pixi lock per workflow, then validate
same-run outputs and build Sphinx. Separate credential-free PR validation from
trusted release-asset creation and serialized Read the Docs API triggers.

Prepare standard Community build hooks that retrieve exact-commit bundles and
restore the execution lock. Document private-repository access prerequisites,
external setup, immutable asset handling, and build ordering limitations.

No remote releases, builds, credentials, or service settings were created.
@mj-will
mj-will marked this pull request as ready for review October 15, 2026 06:45
@mj-will mj-will added the documentation Improvements or additions to documentation label Oct 15, 2026
@mj-will
mj-will merged commit bbbfe6a into main Oct 15, 2026
3 of 4 checks passed
@mj-will
mj-will deleted the docs-build branch October 15, 2026 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant