Add GitHub Pages docs deployment workflow#26
Merged
Merged
Conversation
- Add docs.yml workflow: builds docs on PRs (validation), deploys to GitHub Pages on push to main via actions/deploy-pages - Remove pydoc-markdown and tool from runtime dependencies (only aiohttp is a runtime dep)
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
.github/workflows/docs.ymlthat builds docs withmkdocs build --stricton PRs (validation gate) and deploys to GitHub Pages on push to main usingactions/deploy-pagespydoc-markdownandtoolfrom runtime dependencies (onlyaiohttpshould be a runtime dep)Setup required
After merging, enable GitHub Pages in repo settings:
Settings → Pages → Source → GitHub Actions