Skip to content

Add Sphinx + myst-nb community site deployed to GitHub Pages - #3

Merged
erogluorhan merged 1 commit into
mainfrom
docs-site
Oct 16, 2026
Merged

erogluorhan merged 1 commit into
mainfrom
docs-site

Conversation

@erogluorhan

Copy link
Copy Markdown
Member

Adds a Sphinx + myst-nb site for the community entries, deployed to GitHub Pages.

  • Entry pages and a by-year catalog are generated from entries/ at build time, reusing scripts/build_index.py's metadata parsing
  • Notebooks are never executed (nb_execution_mode = "off"); most need HPC-only data, so committed outputs are rendered as-is, including interactive HoloViews/Bokeh plots that GitHub's notebook viewer can't show
  • PRs build the site; pushes to main deploy it (requires Settings → Pages → Source: GitHub Actions)
  • Preview locally: pip install -r docs/requirements.txt && sphinx-build -b html docs docs/_build/html

Entry pages and a catalog are generated from entries/ at build time,
reusing the metadata parsing in scripts/build_index.py. Notebooks are
never executed (nb_execution_mode = "off"): most need HPC-only data,
so the committed outputs, including interactive HoloViews/Bokeh plots,
are rendered as-is. PRs build the site; pushes to main deploy it.

Also skip hidden folders (e.g. .ipynb_checkpoints) when collecting
entries.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@erogluorhan
erogluorhan merged commit 493e7c0 into main Oct 16, 2026
7 checks passed
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