fix: tester not working

.github/workflows/docs.yml

@@ -22,8 +22,6 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     # NOTE: This also serves as a test for the action.
     - name: Docs

action.yml

@@ -25,7 +25,7 @@ runs:
 
     - name: Install
       run: |
-        pip install git+https://github.com/ApeWorX/sphinx-ape.git@main
+        pip install sphinx-ape
       shell: bash
 
     - name: Build Docs

codeql-config.yml

@@ -0,0 +1,7 @@
+name: "Ape CodeQL config"
+
+queries:
+  - uses: security-and-quality
+
+paths:
+  - sphinx_ape

docs/conf.py

@@ -1 +1,6 @@
 extensions = ["sphinx_ape"]
+
+doctest_global_setup = """
+from sphinx_ape.build import BuildMode, DocumentationBuilder
+from pathlib import Path
+"""

sphinx_ape/_utils.py

@@ -128,7 +128,8 @@ def extract_package_name(directory: Optional[Path] = None) -> str:
     if pkg_name is None and (directory / "pyproject.toml").is_file():
         pkg_name = _extract_name_from_pyproject_toml(directory / "pyproject.toml")
     if pkg_name is None:
-        raise ApeDocsBuildError("No package name found.")
+        path = f"{directory}".replace(f"{Path.home()}", "$HOME")
+        raise ApeDocsBuildError(f"No package name found at '{path}'.")
 
     return PACKAGE_ALIASES.get(pkg_name, pkg_name)
 

sphinx_ape/build.py

@@ -77,11 +77,9 @@ def build(self):
         Build the documentation.
 
         Example:
-            >>> from sphinx_ape.build import BuildMode, DocumentationBuilder
-            >>> from pathlib import Path
             >>> builder = DocumentationBuilder(
             ...   mode=BuildMode.LATEST,
-            ...   base_path=Path("."),
+            ...   base_path=Path.cwd(),
             ...   name="sphinx-ape"
             ... )
             >>> builder.build()

sphinx_ape/testing.py

@@ -10,12 +10,19 @@ class DocumentationTester(Documentation):
     Small wrapper around sphinx-build's doctest command.
     """
 
+    @property
+    def doctest_folder(self) -> Path:
+        """
+        The path to doctest's build folder.
+        """
+        return self.build_path.parent / "doctest"
+
     @property
     def doctest_output_file(self) -> Path:
         """
         The path to doctest's output file.
         """
-        return self.build_path.parent / "doctest" / "output.txt"
+        return self.doctest_folder / "output.txt"
 
     def test(self):
         """
@@ -24,18 +31,19 @@ def test(self):
         Raises:
             :class:`~sphinx_ape.exceptions.ApeDocsTestError`
         """
-        try:
-            subprocess.run(
-                ["sphinx-build", "-b", "doctest", "docs", "docs/_build/doctest"], check=True
-            )
-        except subprocess.CalledProcessError as err:
-            raise ApeDocsBuildError(str(err)) from err
-
-        if self.doctest_output_file.is_file():
-            return
-
+        self._run_tests()
         output = self.doctest_output_file.read_text() if self.doctest_output_file.is_file() else ""
         if "0 failed" in output or "0 tests" in output:
+            # Either no failures or no tests ran.
             return
 
+        # Failures.
         raise ApeDocsTestError(output)
+
+    def _run_tests(self):
+        try:
+            subprocess.run(
+                ["sphinx-build", "-b", "doctest", "docs", str(self.doctest_folder)], check=True
+            )
+        except subprocess.CalledProcessError as err:
+            raise ApeDocsBuildError(str(err)) from err

tests/test_test.py

@@ -0,0 +1,10 @@
+from pathlib import Path
+
+from sphinx_ape.testing import DocumentationTester
+
+
+class TestDocumentationTester:
+    def test_test(self, temp_path):
+        tester = DocumentationTester(base_path=Path(__file__).parent.parent)
+        tester.test()
+        assert tester.doctest_output_file.is_file()