Skip to content

Add Sphinx docs with covariance kernel gallery#35

Merged
jessegrabowski merged 19 commits into
mainfrom
fork/jessegrabowski/docs/sphinx-setup
Jun 12, 2026
Merged

Add Sphinx docs with covariance kernel gallery#35
jessegrabowski merged 19 commits into
mainfrom
fork/jessegrabowski/docs/sphinx-setup

Conversation

@bwengals

@bwengals bwengals commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Scaffold Sphinx documentation with Read the Docs config, autodoc API reference, and narrative doc stubs
  • Add a covariance kernel gallery (inspired by preliz's distribution gallery) with per-kernel detail pages, bibtex citations, and McElreath-style conditional plots
  • Add ptgp.plotting module with plot_kernel_decay, plot_prior_samples, and plot_conditional helpers
  • Add pre-commit hook to flag kernels missing from the gallery
  • Add Linear kernel to the gallery
  • Fix pre-commit failures (E402 import order, missing blank line)

Supersedes #32, which was opened from a fork whose head repo didn't pick up new commits after the repo ownership transfer to pymc-devs.

Test plan

  • cd docs && make show builds the static site and launches a browser
  • Pre-commit passes: pre-commit run --all-files
  • CI green (pytest, mypy, ruff)

@bwengals bwengals requested a review from jessegrabowski June 10, 2026 20:29
@bwengals

Copy link
Copy Markdown
Collaborator Author

CI failed on an update to GPJax, and the fact that a lot of tests just compare to GPJax results (I was lazy). Added isue #36 about this

@jessegrabowski jessegrabowski added documentation Improvements or additions to documentation enhancement New feature or request plotting Relating to plotting helpers for GPs labels Jun 12, 2026
@jessegrabowski jessegrabowski merged commit bf1a7bf into main Jun 12, 2026
6 checks passed
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 enhancement New feature or request plotting Relating to plotting helpers for GPs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants