ziglibs/ansi-term#20
was used as reference for the GitHub Workflow.
Important pre-merge steps:
If this PR is accepted, the following steps should be taken
before merging the PR:
Go to Settings for the repository
Select Pages on the left under Code and automation
Under Build and deployment set Source to GitHub Actions
Merge the PR.
If the steps are missed, the PR will merge just fine,
but the docs job will fail immediately on merge.
This can be remedied by following steps 1-3 above,
and either adding a new commit on master,
or manually firing the workflow from the Actions > API Reference page.
If this is not something you'd like for clap to provide, feel free to close the PR--it didn't require a lot of effort.
A preview of the output is available at https://abhinav.github.io/zig-clap/.
This adds a
zig build docs
step that builds the documentation website and writes it to zig-out/docs.It further includes a GitHub Workflow that publishes this website to GitHub Pages. The GitHub Workflow is divided into two jobs:
These are separate jobs to minimize permissions available to the build job.
This workflow runs on two events:
The instructions to do this came from the following sources:
Important pre-merge steps:
If this PR is accepted, the following steps should be taken before merging the PR:
If the steps are missed, the PR will merge just fine, but the docs job will fail immediately on merge. This can be remedied by following steps 1-3 above, and either adding a new commit on master, or manually firing the workflow from the Actions > API Reference page.