Notebook CI/CD Documentation¶
Automated validation, testing, execution, and documentation for Jupyter
notebook repositories, powered by
spacetelescope/notebook-ci-actions.
Pick the path that matches what you're doing.
Setting up a new notebook repository?
Start with Creating a Repo -- it walks you from an empty repo to passing CI, step by step. New to the terms? See the Glossary.
I write notebooks¶
You contribute notebooks to a repo that already uses this CI. You don't set up or edit the CI itself, you just need your notebooks to pass.
Start with the Quick Reference Read the Full Guide
I maintain a notebook repo¶
You set up the caller workflows, choose which checks run, and manage configuration and updates.
I run the infrastructure¶
You manage the self-hosted runners and the underlying CI infrastructure.
About this site
This site is built from the markdown in the repository's docs/ directory
with MkDocs Material and
deployed to GitHub Pages when documentation changes are pushed to main.