Add Yardang Sphinx extension

yardang/conf.py.j2

@@ -65,6 +65,7 @@ use_llms = {{use_llms}}  # noqa: F821
 # BASE EXTENSIONS #
 ###################
 extensions = [
+    "yardang.sphinx",
     "myst_nb",
     "sphinx.ext.napoleon",
     "sphinx_design",

yardang/sphinx/__init__.py

@@ -0,0 +1,10 @@
+from yardang import __version__
+
+
+def setup(_app) -> dict[str, object]:
+    """Register Yardang as a Sphinx extension."""
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

yardang/tests/test_sphinx.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+
+from yardang import __version__
+from yardang.build import generate_docs_configuration
+from yardang.sphinx import setup
+
+
+def test_setup_returns_extension_metadata():
+    assert setup(None) == {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }
+
+
+def test_generated_configuration_enables_extension(tmp_path, monkeypatch):
+    (tmp_path / "pyproject.toml").write_text('[project]\nname = "test-project"\nversion = "1.0.0"\n')
+    (tmp_path / "README.md").write_text("# Test Project\n")
+    monkeypatch.chdir(tmp_path)
+
+    with generate_docs_configuration() as conf_dir:
+        conf_content = (Path(conf_dir) / "conf.py").read_text()
+
+    assert '"yardang.sphinx"' in conf_content