Refresh documentation styling with Furo theme#2934
Conversation
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/2934/index.html |
|
Array API standard conformance tests for dpnp=0.21.0dev0=py313h509198e_82 ran successfully. |
| @@ -0,0 +1,91 @@ | |||
| /* Autosummary tables: left-aligned */ | |||
There was a problem hiding this comment.
The tab with rendered documentation is currently named as: dpnpData Parallel ... - without any space or separator.
It might be better to do as dpctl: Data Parallel Control (dpctl)
| @@ -0,0 +1,91 @@ | |||
| /* Autosummary tables: left-aligned */ | |||
| .. module:: dpnp | ||
| :no-index: | ||
|
|
||
| Python package :py:mod:`dpnp` implements a subset of `NumPy*`_ that can be |
There was a problem hiding this comment.
Would it be better to rephrase something like:
DPNP is a NumPy-compatible array library that can be executed on any data parallel device. DPNP acts as a drop-in replacement of core NumPy functions and numerical data types.
I wonder about using the word subset of NumPy because it doesn't bring why the user need to use DPNP and what is the subset means in terms of number of numpy functions.
There was a problem hiding this comment.
Also we started to add implementation for some SciPy-relating function and so probably need to highlight that as well.
|
|
||
| .. grid-item-card:: Tensor (dpnp.tensor) | ||
|
|
||
| The underlying Array API-compliant implementation based on |
There was a problem hiding this comment.
Do we need to place a link to dpctl documentaion?
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :caption: Development information |
There was a problem hiding this comment.
Do we need to have that on the main page as well with some description?
It currently provides overview for the function from the extensions.

This PR proposes a refresh of
dpnp documentationstyling and layout by migrating to thefurotheme and improving the overall API documentation appearancesphinx_rtd_themewithfuropyproject.toml,building_docs.yml andbase_build_docs.txtdpnp logo (
dpnp.svg) will be added in the future