' in html
+ assert "list_workspaces" in html
+ assert "Parameters" in html
+
+ def test_property_no_parameters(self, _mod):
+ resolver = _mod.LinkResolver(SAMPLE_LINKS)
+ html = _mod.render_function_html(SAMPLE_PROPERTY_DATA, "CatalogWorkspace.name", resolver)
+ assert "name" in html
+ # Properties should not show a Parameters section
+ assert "Parameters" not in html
+
+
+class TestRenderClassHtml:
+ def test_produces_html_with_methods_and_properties(self, _mod):
+ resolver = _mod.LinkResolver(SAMPLE_LINKS)
+ html = _mod.render_class_html(SAMPLE_CLASS_DATA, "sdk", "sdk.CatalogWorkspace", resolver)
+ assert '
' in html
+ assert "Properties" in html
+ assert "Methods" in html
+ # Private method should be excluded
+ assert "_private" not in html
+
+ def test_class_no_functions(self, _mod):
+ resolver = _mod.LinkResolver(SAMPLE_LINKS)
+ data: dict = {"kind": "class", "functions": {}}
+ html = _mod.render_class_html(data, "sdk", "sdk.Empty", resolver)
+ assert "Properties" in html
+ assert "
None " in html
+
+
+class TestRenderModuleHtml:
+ def test_produces_table(self, _mod):
+ resolver = _mod.LinkResolver(SAMPLE_LINKS)
+ html = _mod.render_module_html(SAMPLE_MODULE_DATA, resolver)
+ assert '
' in html
+ assert "class" in html
+ assert "function" in html
+
+ def test_skips_kind_key(self, _mod):
+ resolver = _mod.LinkResolver(SAMPLE_LINKS)
+ html = _mod.render_module_html(SAMPLE_MODULE_DATA, resolver)
+ # The "kind" key on the module dict itself should not appear as an entry
+ # 1 header row + 2 data rows = 3
+ assert html.count("
") == 3
+
+
+# ===================================================================
+# change_json_root
+# ===================================================================
+
+
+class TestChangeJsonRoot:
+ def test_none_paths_returns_original(self, _mod):
+ data = {"a": 1}
+ assert _mod.change_json_root(data, None) is data
+
+ def test_single_path(self, _mod):
+ data = {"sdk": {"catalog": {"kind": "module"}}}
+ result = _mod.change_json_root(data, ["sdk.catalog"])
+ assert result == {"catalog": {"kind": "module"}}
+
+ def test_multiple_paths(self, _mod):
+ data = {
+ "sdk": {"kind": "module", "cls": {"kind": "class"}},
+ "pandas": {"kind": "module"},
+ }
+ result = _mod.change_json_root(data, ["sdk", "pandas"])
+ assert "sdk" in result
+ assert "pandas" in result
+
+
+# ===================================================================
+# create_file_structure (integration — uses tmp_path)
+# ===================================================================
+
+
+class TestCreateFileStructure:
+ def test_creates_module_class_and_function_files(self, _mod, tmp_path):
+ data = {
+ "mymodule": {
+ "kind": "module",
+ "MyClass": {
+ "kind": "class",
+ "docstring": "A class.",
+ "docstring_parsed": {
+ "short_description": "A class.",
+ "long_description": "",
+ },
+ "functions": {
+ "do_stuff": {
+ "kind": "function",
+ "docstring": "Do stuff.",
+ "signature": {
+ "params": [],
+ "return_annotation": "None",
+ },
+ "docstring_parsed": {
+ "short_description": "Do stuff.",
+ "long_description": "",
+ "params": [],
+ "returns": None,
+ },
+ },
+ "_hidden": {"kind": "function"},
+ },
+ },
+ },
+ }
+ _mod.create_file_structure(data, tmp_path, "/latest/api-reference")
+
+ # Module index
+ module_index = tmp_path / "mymodule" / "_index.md"
+ assert module_index.exists()
+ content = module_index.read_text()
+ assert "mymodule" in content
+
+ # Class index
+ class_index = tmp_path / "mymodule" / "MyClass" / "_index.md"
+ assert class_index.exists()
+ content = class_index.read_text()
+ assert "MyClass" in content
+ assert "python-ref" in content
+
+ # Function page
+ func_page = tmp_path / "mymodule" / "MyClass" / "do_stuff.md"
+ assert func_page.exists()
+ content = func_page.read_text()
+ assert "do_stuff" in content
+
+ # Private function should be skipped
+ assert not (tmp_path / "mymodule" / "MyClass" / "_hidden.md").exists()
+
+ def test_duplicate_names_skipped(self, _mod, tmp_path):
+ data = {
+ "mod1": {
+ "kind": "module",
+ "Shared": {"kind": "class", "functions": {}},
+ },
+ "mod2": {
+ "kind": "module",
+ "Shared": {"kind": "class", "functions": {}},
+ },
+ }
+ # Should not raise — second "Shared" is skipped
+ _mod.create_file_structure(data, tmp_path, "/latest/api-reference")
+ assert (tmp_path / "mod1" / "Shared" / "_index.md").exists()
diff --git a/scripts/generate.sh b/scripts/generate.sh
index 17ce5ee4b..c97873358 100755
--- a/scripts/generate.sh
+++ b/scripts/generate.sh
@@ -119,9 +119,10 @@ highest_version=$(ls -v1 ./versioned_docs/ | grep -E '^[0-9]+.[0-9]+$' | sort -V
echo "Moving ${highest_version} to /latest"
mv -f ./versioned_docs/$highest_version ./versioned_docs/latest
-# Replace "/${highest_version}/" with "/latest/" using sed
-sed "s|${highest_version}|latest|g" ./versioned_docs/latest/links.json > temp.json
-
-mv temp.json ./versioned_docs/latest/links.json
+# Replace "/${highest_version}/" with "/latest/" in links.json (if it exists)
+if [ -f "./versioned_docs/latest/links.json" ]; then
+ sed "s|${highest_version}|latest|g" ./versioned_docs/latest/links.json > temp.json
+ mv temp.json ./versioned_docs/latest/links.json
+fi
popd
diff --git a/scripts/script-requirements.txt b/scripts/script-requirements.txt
index e489e0118..6cc8d065e 100644
--- a/scripts/script-requirements.txt
+++ b/scripts/script-requirements.txt
@@ -1,4 +1,5 @@
docstring_parser~=0.15
+jinja2~=3.1
toml~=0.10.2
-e./gooddata-api-client
-e./packages/gooddata-sdk
diff --git a/uv.lock b/uv.lock
index 82404fa42..2b09e4ddd 100644
--- a/uv.lock
+++ b/uv.lock
@@ -1026,6 +1026,7 @@ test = [
{ name = "pytest-order" },
{ name = "pytest-snapshot" },
{ name = "python-dotenv" },
+ { name = "toml" },
{ name = "urllib3" },
{ name = "vcrpy" },
]
@@ -1071,6 +1072,7 @@ test = [
{ name = "pytest-order", specifier = "~=1.3.0" },
{ name = "pytest-snapshot", specifier = "==0.9.0" },
{ name = "python-dotenv", specifier = "~=1.0.0" },
+ { name = "toml", specifier = "~=0.10.2" },
{ name = "urllib3", specifier = "~=2.6.0" },
{ name = "vcrpy", specifier = "~=8.0.0" },
]
@@ -2460,6 +2462,15 @@ requires-dist = [
{ name = "requests" },
]
+[[package]]
+name = "toml"
+version = "0.10.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/be/ba/1f744cdc819428fc6b5084ec34d9b30660f6f9daaf70eead706e3203ec3c/toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f", size = 22253, upload-time = "2020-11-01T01:40:22.204Z" }
+wheels = [
+ { url = "https://files.pythonhosted.org/packages/44/6f/7120676b6d73228c96e17f1f794d8ab046fc910d781c8d151120c3f1569e/toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", size = 16588, upload-time = "2020-11-01T01:40:20.672Z" },
+]
+
[[package]]
name = "tomli"
version = "2.4.0"