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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add documentation for dpctl enums #2019

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[Docs] Add documentation for dpctl enums #2019

wants to merge 4 commits into from
+57 −4

Conversation

ndgrigorian
Copy link
Collaborator

This PR adds generated documentation for dpctl enums (i.e., device_type, backend_type, etc.)

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

@github-actions GitHub Actions
Copy link

View rendered docs @ https://intelpython.github.io/dpctl/pulls/2019/index.html

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_5 ran successfully.
Passed: 894
Failed: 3
Skipped: 125

@coveralls
Copy link
Collaborator

coveralls commented Feb 27, 2025 •
edited
Loading

Coverage Status

coverage: 87.652%. remained the same
when pulling 6879275 on document-dpctl-enum-types
into c3e6952 on master.

@ndgrigorian ndgrigorian force-pushed the document-dpctl-enum-types branch from c4bae75 to 7e8f2cf Compare March 14, 2025 21:39
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

@ndgrigorian ndgrigorian force-pushed the document-dpctl-enum-types branch from 7e8f2cf to cf203fa Compare March 14, 2025 23:11
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

@ndgrigorian ndgrigorian force-pushed the document-dpctl-enum-types branch from cf203fa to b87710a Compare March 15, 2025 01:57
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

@ndgrigorian ndgrigorian force-pushed the document-dpctl-enum-types branch 2 times, most recently from 48fdce3 to 61c0558 Compare March 15, 2025 03:24
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 894
Failed: 3
Skipped: 126

@ndgrigorian
Add constants.rst for documenting dpctl constants
aa7a0b0 
Also adds custom formatting for Enums into `index.rst`
@ndgrigorian ndgrigorian force-pushed the document-dpctl-enum-types branch from 61c0558 to aa7a0b0 Compare March 15, 2025 05:20
@ndgrigorian ndgrigorian marked this pull request as ready for review March 15, 2025 05:45
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

@ndgrigorian
Reorder constants page
6879275 
This way it matches the order on the index page for `dpctl` module
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_50 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antonwolfy antonwolfy Awaiting requested review from antonwolfy antonwolfy is a code owner

@vlad-perevezentsev vlad-perevezentsev Awaiting requested review from vlad-perevezentsev vlad-perevezentsev is a code owner

@vtavana vtavana Awaiting requested review from vtavana vtavana is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ndgrigorian @coveralls