-
Notifications
You must be signed in to change notification settings - Fork 22
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
Refresh documentation #1485
Conversation
b4608ef
to
b86afa0
Compare
f0fd782
to
81abe9b
Compare
What is the best way to view rendered documentation? |
|
The example in the interplay with |
The abbreviation DPNP is also used on these pages: |
Сould you add examples to the Quick Start Guide? |
I'm going to fix this in some places, but in general it's still allowed to use |
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
The |
00b839b
to
1f6ad3d
Compare
The PR is ready for review, all the comments are applied. Note |
There was a problem hiding this 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
The PR is intended to refresh dpnp documentation and includes:
Overview
pageQuick Start Guide
Quick Start Guide
with examplesC++ backend API Reference
pageDPCtl Usage
page since it contains obsolete exampleAdditionally
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.