Add GitHub Pages deployment workflow#77
Merged
iahncajigas merged 1 commit intomainfrom Mar 24, 2026
Merged
Conversation
- New deploy-docs.yml: builds Sphinx HTML and deploys to GitHub Pages on every push to main (uses actions/deploy-pages v4) - docs/conf.py: switch to sphinx_rtd_theme with navigation options; exclude superpowers/ specs from build - pyproject.toml: add sphinx-rtd-theme>=3.0 to dev dependencies - Add .nojekyll marker in build step to preserve _static/ directories - Includes design spec at docs/superpowers/specs/ The live site at cajigaslab.github.io/nSTAT-python/ has been frozen since Feb 28 because no deployment workflow existed. This fix will automatically deploy fresh docs on every merge to main. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
deploy-docs.ymlworkflow that builds Sphinx HTML withsphinx_rtd_themeand deploys to GitHub Pages on every push to maindocs/conf.pyto use Read the Docs theme with navigation optionssphinx-rtd-theme>=3.0to dev dependencies.nojekyllmarker to preserve Sphinx_static/directoriesThe live site at cajigaslab.github.io/nSTAT-python/ has been frozen since Feb 28 because no deployment workflow existed. After this merges, every push to main will automatically redeploy the docs.
Test plan
docs-buildCI job passes (Sphinx build with -W warnings-as-errors)deploy-docsworkflow triggers on merge to main🤖 Generated with Claude Code