Add ITT/JIT API documentation source files and gh-action to deploy docs to gh-pages#175
Merged
Conversation
Contributor
Author
|
@vikramts please review this PR |
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
Apr 29, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
vikramts
reviewed
May 2, 2025
|
|
||
| Using JIT API | ||
| ============= | ||
|
|
Contributor
Author
There was a problem hiding this comment.
renamed it to consistent with ITT API topic: Compile and Link with JIT API
vikramts
reviewed
May 2, 2025
|
|
||
|
|
||
| Use the static library provided with the product: | ||
|
|
There was a problem hiding this comment.
provided with which product? the JIT API?
Contributor
Author
There was a problem hiding this comment.
updated to "Link the jitprofiling Static Library"
vikramts
reviewed
May 2, 2025
vikramts
suggested changes
May 2, 2025
vikramts
left a comment
vikramts
left a comment
There was a problem hiding this comment.
Added comments, revisions, and some questions to all 39 files :)
Please inform once the changes are complete and I will approve the PR.
lalithsharan-intel
approved these changes
May 28, 2025
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
3 participants
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 ITT/JIT API Documentation from the Intel® VTune Profiler and Intel® Graphics Performance Analyzers User Guides has been consolidated into this repository, providing a single, unified source of information.
This PR introduces the following changes:
docsfolder containing .rst source files for the project documentation, readme with build steps using sphinx and sphinx configuration files.gh-pagesbranch. The workflow triggers on changes to thedocsfolder and ensures the latest documentation is always available online. The documentation is deployed to GitHub Pages, making it accessible via the repository's GitHub Pages URL.The Preview of the rendered documentation is available here: https://eparshut.github.io/ittapi