-
Notifications
You must be signed in to change notification settings - Fork 29
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.
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
Automated generation of API docs #209
Comments
Since I happened to look at
Which they run as part of their CI and deploy to github pages at https://sigstore.github.io/sigstore-python/sigstore.html |
This looks great! Let's do it. I'll add to the v1 release milestone, since it's good to release with some documentation |
There is some work towards this done in #279, but there are a few open questions still:
|
You can see an example of the documentation generated in the action run by downloading the artifact. |
This looks good to me, thank you! I think we might need to reorder the files in the repo as they're not in a good shape for packaging to a wheel. I'll read more about this and experiment to see if we can avoid it, otherwise we need to decide if we wait for #240 or we'd have it rebase again |
#279 has been rebased to account for the layout change in #283, and now makes use of You can see the latest action run and artifact from the PR. |
We are hosting library documentation via GitHub Pages, which requires the feature enabled. For details see sigstore/model-transparency#209. Signed-off-by: Spencer Schrock <sschrock@google.com>
We are hosting library documentation via GitHub Pages, which requires the feature enabled. For details see sigstore/model-transparency#209. Signed-off-by: Spencer Schrock <sschrock@google.com>
If there's a tool to auto-generate / update documentation based on the doc in the code, that'd be helpful.
@mihaimaruseac @spencerschrock
The text was updated successfully, but these errors were encountered: