Skip to content

Add documentation for IPC API #423

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

Merged
merged 1 commit into from
Apr 11, 2024
Merged

Conversation

vinser52
Copy link
Contributor

@vinser52 vinser52 commented Apr 9, 2024

Description

Create documentation for IPC API.
Fixes referencing between documents.

Ref. #404

Checklist

  • Code compiles without errors locally
  • All tests pass locally
  • CI workflows execute properly
  • Extended the README/documentation

@vinser52 vinser52 requested a review from a team as a code owner April 9, 2024 15:38
Copy link
Contributor

@lukaszstolarczuk lukaszstolarczuk left a comment

Choose a reason for hiding this comment

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

do you have a preview of generated version of this docs?

// you'd have to enable GH Pages building and publishing on your fork and push this commit into your main

@vinser52
Copy link
Contributor Author

do you have a preview of generated version of this docs?

I build them locally on my machine.

you'd have to enable GH Pages building and publishing on your fork and push this commit into your main.

Do you have exact instructions on what should be done?

@lukaszstolarczuk
Copy link
Contributor

do you have a preview of generated version of this docs?

I build them locally on my machine.

I guess it should be ok, then

you'd have to enable GH Pages building and publishing on your fork and push this commit into your main.

Do you have exact instructions on what should be done?

Anyway, if you want to build them on your fork, all you have to do is:

  • go to your fork's settings
  • section Pages
  • set source to GitHub Actions (not "deploy from a branch")
  • push changes into the main branch, which should trigger GH Pages workflow (for me it's here )

@bratpiorka bratpiorka merged commit 443333f into oneapi-src:main Apr 11, 2024
74 checks passed
@vinser52 vinser52 deleted the svinogra_ipc_doc branch February 4, 2025 11:39
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.

3 participants