Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

zig init: Add step to generate documentation #22690

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

zig init: Add step to generate documentation #22690

wants to merge 1 commit into from

Conversation

sorairolake
Copy link
Contributor

Add a doc step to build.zig which zig init generates. This step will generate the package documentation from the doc comments.

The generated package documentation can be viewed by running the following in the directory where it was generated:

python -m http.server

Also, add doc comments and doctests to add function to provide an example of these.

Closes #22644

@sorairolake
zig init: Add step to generate documentation
f6e7536 
Add a `doc` step to `build.zig` which `zig init` generates. This step
will generate the package documentation from the doc comments.

The generated package documentation can be viewed by running the
following in the directory where it was generated:

```sh
python -m http.server
```

Also, add doc comments and doctests to `add` function to provide an
example of these.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a step to generate documentation to build.zig which zig init generates
1 participant
@sorairolake