TST,CI: Add workflow to check sdist. (#670)

* TST,CI: Add workflow to check sdist.

* Split build + install, limit to one Python.

* CI,TST: Prevent test file pickup from source dir.

* TST: Update tst paths to pkged paths

* replace relpath in example_module tst fixture.

* Update __main__ rel to install path.

* Update importlib.resources.path incantation to
  a pattern that works on 3.12 and 3.14.

* Use cwd instead of requests.root_dir

* pyproject: include example_module.py

Closes #668

* Fixup after rebase.

* Add note about strange importlib.resource pattern.

---------

Co-authored-by: Julien Schueller <[email protected]>

Author: rossbar

.github/workflows/test.yml

@@ -182,3 +182,42 @@ jobs:
       - name: Test coverage
         run: |
           codecov
+
+  test-sdist:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ubuntu]
+        python-version: ["3.14"]
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Python setup
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup environment
+        run: |
+          python -m pip install --upgrade pip wheel setuptools build
+          python -m pip list
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --group test --group doc
+          pip list
+
+      - name: Build numpydoc
+        run: python -m build
+
+      - name: Install numpydoc from source tarball
+        run: |
+          python -m pip install --no-binary numpydoc dist/*.tar.gz
+          pip list
+
+      - name: Run test suite
+        # NOTE: Move outside of source directory to prevent any file pickup -
+        # ensure all tests/tests files are derived from the package *only*
+        run: |
+          mkdir foo && cd foo
+          pytest -v --pyargs numpydoc

numpydoc/tests/hooks/test_utils.py

@@ -30,7 +30,7 @@ def test_find_project_root(tmp_path, request, reason_file, files, expected_reaso
         for file in files:
             (tmp_path / file).touch()
     else:
-        expected_dir = request.config.rootdir
+        expected_dir = Path.cwd()
 
     root_dir, reason = utils.find_project_root(files if not files else [tmp_path])
     assert reason == expected_reason

numpydoc/tests/hooks/test_validate_hook.py

@@ -1,24 +1,25 @@
 """Test the numpydoc validate pre-commit hook."""
 
+import importlib.resources
 import inspect
 import re
 from pathlib import Path
 
 import pytest
 
+import numpydoc
 from numpydoc.hooks.validate_docstrings import run_hook
 
 
 @pytest.fixture
 def example_module(request):
-    fullpath = (
-        Path(request.config.rootdir)
-        / "numpydoc"
-        / "tests"
-        / "hooks"
-        / "example_module.py"
-    )
-    return str(fullpath.relative_to(request.config.rootdir))
+    # TODO: When Python3.13 is the minimum version supported version, this
+    # can be simplified to:
+    # with importlib.resources.path(numpydoc, "tests/hooks/example_module.py") as fpath:
+    #     fullpath = str(fpath)
+    with importlib.resources.path(numpydoc, "tests") as fpath:
+        fullpath = str(fpath / "hooks/example_module.py")
+    return str(fullpath)
 
 
 @pytest.mark.parametrize("config", [None, "fake_dir"])

numpydoc/tests/test_main.py

@@ -1,3 +1,4 @@
+import importlib.resources
 import inspect
 import io
 import sys
@@ -119,12 +120,15 @@ def test_validate_perfect_docstring():
 
 @pytest.mark.parametrize("args", [[], ["--ignore", "SS03"]])
 def test_lint(capsys, args):
-    argv = ["lint", "numpydoc/__main__.py"] + args
+    with importlib.resources.path(numpydoc, "__main__.py") as fpath:
+        strpath = str(fpath)
+
+    argv = ["lint", strpath] + args
     if args:
         expected = ""
         expected_status = 0
     else:
-        expected = "numpydoc/__main__.py:1: SS03 Summary does not end with a period"
+        expected = f"{strpath}:1: SS03 Summary does not end with a period"
         expected_status = 1
 
     return_status = numpydoc.cli.main(argv)

pyproject.toml

@@ -168,7 +168,7 @@ attr = 'numpydoc.__version__'
 [tool.setuptools.package-data]
 numpydoc = [
     'tests/test_*.py',
-    'tests/hooks/test_*.py',
+    'tests/hooks/*.py',
     'tests/tinybuild/Makefile',
     'tests/tinybuild/index.rst',
     'tests/tinybuild/*.py',