Automatically create documentation and deploy to GitHub Pages #4
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.
Scope and purpose of changes
Every good library needs documentation.
This PR adds automatic creation of web-based documentation and deploying to GitHub Pages upon every non-preview release from the main branch.
Types of changes
Additions to Cake scripts and GitHub workflows.
Proposed changes / fixed issues
A new
deploy-paged
workflow is automatically dispatched by theRelease
Cake target immediately before publishing a release, provided that it is not a prerelease and the workflow runs on themain
branch.The new workflow:
All static parts of the documentation site (home page, TOC, etc.) still have their default contents. A subsequent PR will provide more sensible contents; for now, testing the new workflow has a higher priority.
Contributor's checklist
CHANGELOG.md
, according to the modifications I made