Skip to content

Clean up stale documentation and references - #3106

Open
antonwolfy wants to merge 3 commits into
masterfrom
docs-cleanup
Open

antonwolfy wants to merge 3 commits into
masterfrom
docs-cleanup

Conversation

@antonwolfy

Copy link
Copy Markdown
Contributor

This PR cleans up stale documentation and references, one commit per change:

  1. Quick start guide. The testing section suggested pytest -s tests, but there is no top-level tests directory; it now gives python -m pytest dpnp/tests for the source tree and python -m pytest --pyargs dpnp.tests for an installed package. The scikit-build recipes now pass --no-build-isolation to pip install -e ., as scripts/build_locally.py does, so pip doesn't rebuild the package in an isolated environment with build dependencies from PyPI. The guide now says the driver script works on Linux and Windows, and a code-block that didn't render because it had no blank line before its content is fixed.
  2. API reference toctree. doc/reference/index.rst listed 14 pages that don't exist (special, sparse, ndimage, generic, memory, cuda, memoize, kernel, optimize, interoperability, testing, prof, environment, misc); they are removed. doc/reference/polynomials.rst, a placeholder whose entries are all commented out and which routines.rst leaves out on purpose, is marked :orphan:. Both produced Sphinx warnings.
  3. Stale files and references.
    • .github/workflows/Windows-IntelLLVM_3.22.cmake is removed: nothing uses it, and conda-recipe/bld.bat applies only the 3.26 copy.
    • doc/docstring_template.py described a fallback to NumPy and an array printing format that no longer exist; it now shows the docstring layout dpnp uses.
    • The 110 dpctl.tensor references left in dpnp/tensor docstrings and comments now say dpnp.tensor. Every referenced name exists in dpnp.tensor; on the same lines, :module: is fixed to :mod: and a misspelled usm_ndarrays to usm_ndarray.
  • Have you provided a meaningful PR description?
  • 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?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?

There is no top-level tests directory, so pytest -s tests found nothing;
point to dpnp/tests and to --pyargs dpnp.tests instead. Pass
--no-build-isolation to the editable install, as build_locally.py does,
mention that build_locally.py also works on Windows, and add the blank
line a code-block needs to render.
doc/reference/index.rst listed 14 pages that do not exist. Also mark the
polynomials placeholder page as orphan, since routines.rst leaves it out
on purpose. Both produced Sphinx warnings.
Remove the unused Windows-IntelLLVM_3.22.cmake, update the docstring
template to the layout dpnp docstrings use, and replace the dpctl.tensor
references left in dpnp/tensor with dpnp.tensor.
antonwolfy added a commit that referenced this pull request Oct 15, 2026
doc/docstring_template.py is current again, dpnp/tensor no longer
mentions dpctl.tensor, and placeholder pages are marked :orphan:.
@antonwolfy antonwolfy self-assigned this Oct 15, 2026
@antonwolfy antonwolfy added this to the 0.21.0 release milestone Oct 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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

@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Status

No base build to compare — docs-cleanup into master

@github-actions

Copy link
Copy Markdown
Contributor

Array API standard conformance tests for dpnp=0.21.0dev14=np2py314h8d9cdd5_7 ran successfully.
Passed: 1376
Failed: 0
Skipped: 6

This branch has not been deployed

No deployments
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.

2 participants