Skip to content

[Documentation] Update to overview section of documentation #1341

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
Merged
merged 6 commits into from
Feb 28, 2024
Merged

[Documentation] Update to overview section of documentation #1341

merged 6 commits into from
Feb 28, 2024

Conversation

@diptorupd
Copy link
Contributor

@diptorupd diptorupd commented Feb 16, 2024 •
edited
Loading

  • Have you provided a meaningful PR description?

Documentation updates for numba-dpex:

  1. Polished up the Overview section
  2. Adds API documentation for more functionality
  3. Initial changes and stubs for redesigning the kernel programming tutorial
  4. Fixes and improvements to docstrings
  5. Moves dpnp compilation and prange support related pages into a new Experimental section of the documentation site.
  • 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?
  • If this PR is a work in progress, are you filing the PR as a draft?

@diptorupd diptorupd marked this pull request as draft February 16, 2024 15:45
@github-actions
Copy link
Contributor

github-actions bot commented Feb 16, 2024

Documentation preview: show.

adarshyoga
adarshyoga reviewed Feb 20, 2024
View reviewed changes
@diptorupd diptorupd force-pushed the docs/overview branch 3 times, most recently from 5fa8a94 to d573aa7 Compare February 24, 2024 22:34
@diptorupd diptorupd marked this pull request as ready for review February 24, 2024 22:36
@diptorupd
Copy link
Contributor Author

diptorupd commented Feb 24, 2024

@adarshyoga can you proof the Overview Section once more? I have made few other changes, but they are mostly to silence warnings etc., I will keep updating docs in separate PRs. Keeping alive one big PR is troublesome.

@diptorupd diptorupd force-pushed the docs/overview branch 2 times, most recently from 285381b to 4a7419a Compare February 25, 2024 01:25
@diptorupd diptorupd changed the title Update to overview section of documentation [Documentation] Update to overview section of documentation Feb 25, 2024
@diptorupd diptorupd force-pushed the docs/overview branch 7 times, most recently from 4a8c9d7 to bb6ce2a Compare February 26, 2024 19:47
adarshyoga
adarshyoga approved these changes Feb 27, 2024
View reviewed changes
Copy link
Contributor

@adarshyoga adarshyoga left a comment

Choose a reason for hiding this comment

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

Overview has come out well.

@diptorupd diptorupd force-pushed the docs/overview branch 4 times, most recently from 3b66bad to cdfc640 Compare February 28, 2024 21:04
@diptorupd diptorupd merged commit 4b1c8a9 into main Feb 28, 2024
@diptorupd diptorupd deleted the docs/overview branch February 28, 2024 22:48
@github-actions
Copy link
Contributor

github-actions bot commented Feb 28, 2024

Documentation preview removed.

github-actions bot added a commit that referenced this pull request Feb 28, 2024
@github-actions
Merge pull request #1341 from IntelPython/docs/overview
c764ee3 
[Documentation] Update to overview section of documentation 4b1c8a9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ZzEeKkAa ZzEeKkAa Awaiting requested review from ZzEeKkAa

1 more reviewer

@adarshyoga adarshyoga adarshyoga approved these changes

Reviewers whose approvals may not affect merge requirements

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

@diptorupd @adarshyoga