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

Refresh documentation #1485

Merged
merged 11 commits into from
Aug 1, 2023
Merged

Refresh documentation #1485

merged 11 commits into from
Aug 1, 2023

Conversation

antonwolfy
Copy link
Contributor

@antonwolfy antonwolfy commented Jul 18, 2023

The PR is intended to refresh dpnp documentation and includes:

  • adding Overview page
  • adding Quick Start Guide
  • extending Quick Start Guide with examples
  • decoupling external links to a separate file
  • refactoring C++ backend API Reference page
  • hidding DPCtl Usage page since it contains obsolete example

Additionally build sphinx action is extended to publish docs which is generated by the PR. They are temporary placed to a separate folder on web page and available for reviewing. Once the PR is closed, the temporary directory is released and all artifacts are cleaned up.

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to 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?
  • If this PR is a work in progress, are you filing the PR as a draft?

@antonwolfy antonwolfy self-assigned this Jul 18, 2023
@antonwolfy antonwolfy changed the title Updated Overview page Refresh documentation Jul 18, 2023
@antonwolfy antonwolfy force-pushed the update_docs branch 2 times, most recently from b4608ef to b86afa0 Compare July 18, 2023 11:55
@antonwolfy antonwolfy force-pushed the update_docs branch 3 times, most recently from f0fd782 to 81abe9b Compare July 18, 2023 19:27
@oleksandr-pavlyk
Copy link
Contributor

What is the best way to view rendered documentation?

@oleksandr-pavlyk
Copy link
Contributor

What is the best way to view rendered documentation?

https://intelpython.github.io/dpnp/pull/1485/

@oleksandr-pavlyk
Copy link
Contributor

The example in the interplay with dpctl is outdated. We no longer use context manager to control offload target...

@npolina4
Copy link
Collaborator

The abbreviation DPNP is also used on these pages:
API Reference / Multi-Dimensional Array (ndarray)
API Reference / Universal Functions (ufunc)
API Reference / Difference between DPNP and NumPy
API Reference / Comparison Table
API Reference / Miscellaneous routines
C++ backend API Reference

@npolina4
Copy link
Collaborator

Сould you add examples to the Quick Start Guide?

doc/quick_start_guide.rst Outdated Show resolved Hide resolved
@antonwolfy
Copy link
Contributor Author

antonwolfy commented Jul 19, 2023

The abbreviation DPNP is also used on these pages: API Reference / Multi-Dimensional Array (ndarray) API Reference / Universal Functions (ufunc) API Reference / Difference between DPNP and NumPy API Reference / Comparison Table API Reference / Miscellaneous routines C++ backend API Reference

I'm going to fix this in some places, but in general it's still allowed to use dpnp abbreviation in the context of package name.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 19, 2023

View rendered docs @ https://intelpython.github.io/dpnp/index.html

@antonwolfy
Copy link
Contributor Author

What is the best way to view rendered documentation?

The build sphinx action is updated to post a comment with a link to the rendered docs.

@antonwolfy antonwolfy force-pushed the update_docs branch 2 times, most recently from 00b839b to 1f6ad3d Compare July 26, 2023 22:39
@antonwolfy
Copy link
Contributor Author

The PR is ready for review, all the comments are applied.

Note Conda package / Test actions on Windows are failing due to known issue #12928 in conda 23.7.0 which was resolved in 23.7.1 but not available yet on the channel.

Copy link
Collaborator

@vlad-perevezentsev vlad-perevezentsev left a comment

Choose a reason for hiding this comment

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

The updated documentation looks great!
Thanks a lot @antonwolfy

@antonwolfy antonwolfy merged commit 6239281 into master Aug 1, 2023
21 checks passed
@antonwolfy antonwolfy deleted the update_docs branch August 1, 2023 16:42
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.

4 participants