PrincetonUniversity / slurmise / 33660172693

91%

push

github

docs: publish the Sphinx site to GitHub Pages (#106)

* wip: stub sphinx, poe task, and GHA docs builds

* feat: add dev docs with under-development banner

- Add a `poe docs-dev` to build with a warning banner
- The GHA workflow now builds with the banner on all branches and
  deploys to Pages on every push, not just main.
- Eventually maybe use JamesIves/github-pages-deploy-action to
  have separate docs pages for "dev" and "active"

* Upgrade upload-pages-artifact action to v4

* chore: Bump gha versions for docs.yaml

* chore: Link github pages docs in the README

* docs: write a real landing page for the docs site

Replace the sphinx-quickstart boilerplate on the index with a short
description of what slurmise is and the problem it solves, so the
published site opens on something other than a note to the author.

Assisted-by: Claude Code:claude-opus-5

* ci: attach the built docs to every run for review

Assisted-by: Claude Code:claude-opus-5

* ci: only deploy the docs site from main

Pushes from other branches were reaching the deploy job and failing there,
because the github-pages environment only admits main. Gate the job on the
branch so those runs skip it and stay green.

Each run now uploads whichever artifact is useful to it: the Pages tarball on
main, where it gets published, and a plain zip of the rendered site everywhere
else, where there is nothing to look at otherwise.

Assisted-by: Claude Code:claude-opus-5

* ci: build docs once per commit

Docs branches matched both the push and pull_request triggers, so every
commit on an open PR built twice. Only main needs the push trigger, since
only main deploys.

Assisted-by: Claude Code:claude-opus-5

* fix: skip documentation build in test GHA

Removed documentation build step from test.yaml CI workflow which was redundant with the docs.yaml

---------

Co-authored-by: Ioannis Paraskevakos <iparask@princeton.edu>
Co-authored-by: Troy Comi <troycomi@gmail.com>

290 of 332 branches covered (87.35%)

Branch coverage included in aggregate %.

2164 of 2378 relevant lines covered (91.0%)

0.91 hits per line