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 Profiling API section and document ProfilingSection and ScopedRegion #480

Merged
merged 1 commit into from
Jan 12, 2024

Conversation

dalg24
Copy link
Member

@dalg24 dalg24 commented Jan 2, 2024

I keep getting the following error

docs/source/API/core/profiling/scoped_region.rst:40: WARNING: Could not lex literal_block as "cpp". Highlighting skipped.

I would appreciate some help to fix

I intend to get into the documentation of the profiling interface in follow up PRs.
This PR specifically documents the Profiling::ProfilingSection and Profiling::ScopedRegion RAII-style helper classes.

@dalg24 dalg24 added the documentation Improvements or additions to documentation label Jan 2, 2024
.. role:: cppkokkos(code)
:language: cppkokkos

Defined in header ``<Kokkos_Profiling_ProfileSection.hpp>``
Copy link
Member Author

Choose a reason for hiding this comment

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

Hadn't even realized the name is "ProfileSection" and not "ProfilingSection"...
Yuk

@dalg24
Copy link
Member Author

dalg24 commented Jan 9, 2024

Rendering is fixed. This is ready for review/merge

@crtrott crtrott merged commit feba529 into kokkos:main Jan 12, 2024
1 check passed
@dalg24 dalg24 deleted the profiling branch January 12, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants