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.

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

Add docs #35

Merged
merged 10 commits into from
Feb 22, 2024
Merged

Add docs #35

merged 10 commits into from
Feb 22, 2024

Conversation

oleksandr-pavlyk
Copy link
Collaborator

This PR adds initial docs and workflow to build/render it.

@oleksandr-pavlyk oleksandr-pavlyk force-pushed the add-docs branch 2 times, most recently from f1643d7 to 15e0975 Compare February 20, 2024 22:45
@oleksandr-pavlyk
Copy link
Collaborator Author

oleksandr-pavlyk commented Feb 22, 2024

For pull-requests, like this one, documentation is rendered and uploaded as workflow's artifact (see "Build mkl_random documentation" workflow). The artifact is a ZIP archive which contains rendered documentation pages. Unarchive it, and open index.html in your browser.

Once this PR is merged into main branch, this copy is going to be pushed to gh-pages branch, and it should becomes visible at https://intelpython.github.com/mkl_random

It usually takes a couple of minutes after push to gh-pages before content is transferred to the HTTP server.

Copy link

@ndgrigorian ndgrigorian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All seems to render correctly, artifact works, LGTM!

@oleksandr-pavlyk oleksandr-pavlyk merged commit 5e2fd3b into master Feb 22, 2024
18 checks passed
@oleksandr-pavlyk oleksandr-pavlyk deleted the add-docs branch February 22, 2024 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants