Adds a zig build docs step to build documentation website,
and a new GitHub Workflow that publishes the website to GitHub Pages.
This workflow is divided into two jobs:
build: builds the documentation and uploads it
publish: downloads the documentation and publishes it
These are separate jobs to minimize permissions available
to the build job.
To use this, you have to take the following steps:
Go to Settings for the repository
Select Pages on the left under Code and automation
Under Build and deployment set Source to GitHub Actions
Note that this workflow dispatches on two events:
after every push to master
workflow_dispatch: this allows manually running the workflow
from its Actions page if something went wrong
The workflow itself is a separate workflow to make it more copy-paste friendly.
Note on stability:
One of the points made by @joachimschmidt557 in #13 was that
the generated docs must explicitly call out that the documentation is
unstable/WIP.
Because this uses the same tooling as Zig std,
the generated pages include the following header at the top:
This is a beta autodoc build; expect bugs and missing information.
Preview: A preview of the result of this PR is available at https://abhinav.github.io/ansi-term/
Adds a
zig build docs
step to build documentation website, and a new GitHub Workflow that publishes the website to GitHub Pages.This workflow is divided into two jobs:
These are separate jobs to minimize permissions available to the build job.
To use this, you have to take the following steps:
Note that this workflow dispatches on two events:
workflow_dispatch
: this allows manually running the workflow from its Actions page if something went wrongThe workflow itself is a separate workflow to make it more copy-paste friendly.
Note on stability: One of the points made by @joachimschmidt557 in #13 was that the generated docs must explicitly call out that the documentation is unstable/WIP.
Because this uses the same tooling as Zig std, the generated pages include the following header at the top:
Resolves #13