Add GitHub Actions workflow for automated documentation deployment #68
Conversation
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
This commit sets up automatic deployment of documentation to GitHub Pages when code is merged to the main branch. Changes: - Add .github/workflows/docs.yml: CI workflow that builds and deploys docs to GitHub Pages using the official deploy-pages action - Fix docs/Makefile: Replace BSD sed-incompatible command with cross-platform solution in generate-readme target for macOS compatibility The workflow builds complete documentation (README + API reference + user guide) using the existing build-all-docs target and deploys to github.io/pyoats/. Closes the issue where https://georgian-io.github.io/pyoats-docs/ returned 404. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
paulinder
commented
Oct 22, 2025
paulinder
had a problem deploying
to
github-pages
GitHub Actions
Failure
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.
Sets up automatic deployment of documentation to GitHub Pages when code is merged to the main branch.
Changes:
The workflow builds complete documentation (README + API reference + user guide) using the existing build-all-docs target and deploys to github.io/pyoats/.
....
docs deploy will not work until enabled at https://github.com/georgian-io/pyoats/settings/pages