IntelPython / dpnp / 39269619497

83%

push

github

Clean up stale documentation and references (#3106)

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`.

1604 of 2994 branches covered (53.57%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 3 files covered. (100.0%)

29395 of 34528 relevant lines covered (85.13%)

19628.71 hits per line