Use numpydoc to render the API reference - #3059
Conversation
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/3059/index.html |
|
Array API standard conformance tests for dpnp=0.21.0dev8=py314ha0e2e8e_9 ran successfully. |
|
Small rendering mismatch vs the legacy build worth a fix: parameter/return types now render upright + semibold instead of italic.
Cause is purely CSS. numpydoc emits the type as Proposed fix, add to /* numpydoc param/return types: italic like NumPy, not bold */
.classifier {
font-style: italic;
font-weight: 400;
} |
This PR switches the documentation build from
sphinx.ext.napoleontonumpydocto render the API reference.numpydocrenders theParametersandReturnssections as definition lists out of the box, which lets us remove:doc/_static/dpnp-custom.jsthat reformatted parameterdescriptions, together with the CSS rules that only supported it;
Returns(numpydoc handles itnatively).
A small hook keeps the dpnp-specific
Limitationssection and a some docstrings are adjusted for numpydoc's stricter parser.