Tests and docs workflow - #11
Merged
Merged
Conversation
…f committing them
This ensures the actual code is documented, and keeps doc generation out of normal code builds
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
To build docs into /zig-output/docs from /docs
Run
To view on local test web server
The docs have been generated with
-femit-docsas 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.