Repository navigation
Conversation
Adds a Docs workflow that builds the Sphinx HTML on every push and pull request to main, and deploys it to GitHub Pages on pushes to main (or a manual run from main). Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <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
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.
Closes #67
Summary
Adds
.github/workflows/docs.yml, which publishes the Sphinx docs to https://idaholabresearch.github.io/DCAF/ whenever a GitHub release is published (nothing runs on pushes or PRs).uv sync --locked, builds the docs withsphinx-build -b html docs docs/_build/html, and uploads the HTML withactions/upload-pages-artifact@v5.actions/deploy-pages@v5to thegithub-pagesenvironment.contents: readfor the workflow, andpages: write+id-token: writeonly on the deploy job. A singlepagesconcurrency group stops two deploys from running at once.Required one-time setup (repo admin)
github-pages→ Deployment branches and tags: add a tag rule matching the release tags (e.g.v*). This environment is created when step 1 is done and only allows the default branch at first. Release runs come from the tag ref, so without this rule the deploy is rejected with "Tag ... is not allowed to deploy to github-pages due to environment protection rules".Test plan
sphinx-build -b html docs <out>succeeds locally (4 existing, non-fatal warnings: the missing_staticdir and the unknownmermaidPygments lexer)pre-commit run --all-filespasses🤖 Generated with Claude Code