fix: sphinx design

Author: lwasser

pyproject.toml

@@ -80,10 +80,10 @@ dependencies = [
     "mkdocs-awesome-pages-plugin ~=2.9",
     "pydata_sphinx_theme ~=0.16",
     "myst-parser ~=4.0",
-    "Sphinx ~=8.0",
+    "sphinx ~=8.0",
     "sphinx-autobuild>=2024.10.3",
     "sphinx-autoapi>=3.6.0",
-    "sphinx-design>=0.6.1",
+    "sphinx_design>=0.6.1",
     "sphinx-copybutton",
 ]
 

template/pyproject.toml.jinja

@@ -93,7 +93,7 @@ docs = [
     "pydata-sphinx-theme~=0.16",
     "sphinx-autobuild>=2024.10.3",
     "sphinx-autoapi>=3.6.0",
-    "sphinx-design>=0.6.1",
+    "sphinx_design>=0.6.1",
     "sphinx-copybutton>=0.5.2",
 {%- elif documentation == "mkdocs" %}
     "mkdocs-material ~=9.5",

tests/test_template_init.py

@@ -178,7 +178,7 @@ def test_template_suite(
 @pytest.mark.installs
 @pytest.mark.parametrize("use_hatch_envs", [True, False])
 def test_docs_build(documentation: str, generated: Callable[..., Path], use_hatch_envs: bool):
-    """The docs should build."""
+    """The docs should build both with and without hatch environments."""
     if documentation == "no":
         return
 
@@ -193,7 +193,8 @@ def test_docs_build(documentation: str, generated: Callable[..., Path], use_hatc
             pytest.skip(
                 "Dont know enough about invoking shell commands on windows for this :(",
             )
-        run_command("sphinx-apidoc -o docs/api src/alien_clones", project)
+        # With autoapi we shouldn't have to manually run sphinx-apidoc anymore
+        #run_command("sphinx-apidoc -o docs/api src/alien_clones", project)
         # prepend pythonpath so we don't have to actually install here...
         run_command(f"PYTHONPATH={str(project/'src')} sphinx-build -W -b html docs docs/_build", project)