Skip to content

Tests and docs workflow - #11

Merged
meganasampson merged 11 commits into
devfrom
ms-dev
Aug 6, 2026
Merged

Tests and docs workflow#11
meganasampson merged 11 commits into
devfrom
ms-dev

Conversation

@meganasampson

Copy link
Copy Markdown
Contributor

The following changes should run tests and deploy docs that have been created to github pages when pushed to main.

To see docs locally before on main:

Run

zig build docs

To build docs into /zig-output/docs from /docs

Run

python -m http.server 8000 -d docs/

To view on local test web server

The docs have been generated with -femit-docs as seen here. They are not the best and only touch on the zig portion of the code for now. Can change to prioritise the python if you'd rather, but this is a start.

@meganasampson meganasampson added the documentation Improvements or additions to documentation label Jul 2, 2026
@james-panayis

Copy link
Copy Markdown
Collaborator

This looks great! I've just done a few changes (mostly making the docs generate during the CI instead of committing them directly, and adding the python tests).

@meganasampson
meganasampson merged commit a23ff49 into dev Aug 6, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants