From 7af04ee30d40e02e47bef4229bd823b541a0a352 Mon Sep 17 00:00:00 2001
From: Abhinav Gupta
Date: Thu, 21 Dec 2023 15:26:03 -0800
Subject: 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.
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index f74c11f..d7ecda1 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,12 @@ in the release notes.
 * Print help message from parameter specification.
 * Parse help message to parameter specification.
 
+## API Reference
+
+Automatically generated API Reference for the project
+can be found at https://Hejsil.github.io/zig-clap.
+Note that Zig autodoc is in beta; the website may be broken or incomplete.
+
 ## Examples
 
 ### `clap.parse`
-- 
cgit v1.2.3