diff options
| author | 2023-12-21 15:26:03 -0800 | |
|---|---|---|
| committer | 2024-01-02 13:16:54 +0100 | |
| commit | 7af04ee30d40e02e47bef4229bd823b541a0a352 (patch) | |
| tree | 0f45f6b05e76fb5aa6a2bf037543a7b8965bd98b /README.md | |
| parent | Remove the default allocator from `ParseOptions` (diff) | |
| download | zig-clap-7af04ee30d40e02e47bef4229bd823b541a0a352.tar.gz zig-clap-7af04ee30d40e02e47bef4229bd823b541a0a352.tar.xz zig-clap-7af04ee30d40e02e47bef4229bd823b541a0a352.zip | |
Add autodoc website
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:
- 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.
This workflow runs on two events:
- after every push to master
- `workflow_dispatch`: this allows manually running the workflow
from its *Actions* page if something went wrong
---
**Important pre-merge steps:**
If this PR is accepted, the following steps should be taken
before merging the PR:
1. Go to **Settings** for the repository
2. Select **Pages** on the left under *Code and automation*
3. Under *Build and deployment* set **Source** to **GitHub Actions**
4. 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.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
| @@ -23,6 +23,12 @@ in the release notes. | |||
| 23 | * Print help message from parameter specification. | 23 | * Print help message from parameter specification. |
| 24 | * Parse help message to parameter specification. | 24 | * Parse help message to parameter specification. |
| 25 | 25 | ||
| 26 | ## API Reference | ||
| 27 | |||
| 28 | Automatically generated API Reference for the project | ||
| 29 | can be found at https://Hejsil.github.io/zig-clap. | ||
| 30 | Note that Zig autodoc is in beta; the website may be broken or incomplete. | ||
| 31 | |||
| 26 | ## Examples | 32 | ## Examples |
| 27 | 33 | ||
| 28 | ### `clap.parse` | 34 | ### `clap.parse` |