Skip to content

fix(ci): deploy Sphinx docs to gh-pages for project Pages URL#348

Merged
gbg141 merged 1 commit into
mainfrom
fix/deploy-docs-gh-pages
Jun 2, 2026
Merged

fix(ci): deploy Sphinx docs to gh-pages for project Pages URL#348
gbg141 merged 1 commit into
mainfrom
fix/deploy-docs-gh-pages

Conversation

@mathildepapillon

Copy link
Copy Markdown
Collaborator

Summary

The public URL https://geometric-intelligence.github.io/topobench/ is served from this repository’s gh-pages branch (project Pages), not from geometric-intelligence.github.io/topobench/. This PR deploys the Sphinx build to gh-pages using GITHUB_TOKEN, adds .nojekyll, fixes the github.repository guard to geometric-intelligence/topobench, and adds workflow_dispatch for manual redeploys.

After merge (maintainer checklist)

  1. Settings → Actions → General → Workflow permissions: set Read and write so GITHUB_TOKEN can push gh-pages (if not already).
  2. Confirm Settings → Pages uses gh-pages branch, / (root).
  3. Open Actions → Docs: Check and Deploy for the merge commit and wait until it succeeds (or use Run workflow).
  4. Verify the site: Sphinx/pydata layout at https://geometric-intelligence.github.io/topobench/ and https://geometric-intelligence.github.io/topobench/.nojekyll returns 200.

Test plan

  • Merge PR, confirm docs workflow is green on main.
  • Spot-check docs homepage and a challenge subpage after deploy.

Made with Cursor

The live site is served from this repo's gh-pages branch, not the org
.github.io mirror. Deploy there with GITHUB_TOKEN, add .nojekyll, fix
repository name checks, and allow manual workflow_dispatch runs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@gbg141 gbg141 merged commit 2f874b3 into main Jun 2, 2026
4 checks passed
@codecov

codecov Bot commented Jun 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.03%. Comparing base (04a409c) to head (28f3241).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #348   +/-   ##
=======================================
  Coverage   94.03%   94.03%           
=======================================
  Files         206      206           
  Lines        8732     8732           
=======================================
  Hits         8211     8211           
  Misses        521      521           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

2 participants