cpdocs 0.3.8__tar.gz → 0.3.9__tar.gz

{cpdocs-0.3.8 → cpdocs-0.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cpdocs
-Version: 0.3.8
+Version: 0.3.9
 Summary: Semantic, versioned API documentation for C, C++, CUDA, HIP, Fortran, Python and Rust projects
 Project-URL: Source, https://github.com/ambhora/cpdocs
 Author-email: Jayesh Badwaik <j.badwaik@fz-juelich.de>

{cpdocs-0.3.8 → cpdocs-0.3.9}/src/cpdocs/__init__.py

@@ -4,4 +4,4 @@
 # --------------------------------------------------------------------------------------------------
 """Language-neutral semantic API documentation generator."""
 
-__version__ = "0.3.8"
+__version__ = "0.3.9"

{cpdocs-0.3.8 → cpdocs-0.3.9}/src/cpdocs/providers/contract.py

@@ -43,15 +43,12 @@ def language_template_values(configuration: dict[str, object]) -> dict[str, str]
                 raise RuntimeError(f"cpdocs.yml: language property {path!r} is reserved")
             result[path] = str(value).lower() if isinstance(value, bool) else str(value)
         else:
-            raise RuntimeError(
-                f"cpdocs.yml: language property {path!r} must be a scalar value"
-            )
+            raise RuntimeError(f"cpdocs.yml: language property {path!r} must be a scalar value")
 
     visit("", configuration)
     return result
 
 
-
 def _expand(command: str, values: dict[str, str], *, allowed: set[str], name: str) -> str:
     placeholders = set(_PLACEHOLDER.findall(command))
     unknown = sorted(placeholders - allowed)

{cpdocs-0.3.8 → cpdocs-0.3.9}/src/cpdocs/rendering/html.py

@@ -1073,8 +1073,7 @@ def _feature_sets_page(graph: ApiGraph, document: Path) -> tuple[str, list[tuple
         body.append(
             f'<tr id="{html.escape(anchor)}">'
             f'<th scope="row">{index}</th>'
-            "<td>" + _feature_set_inline(graph, key) + "</td>"
-            + configuration_column + "</tr>"
+            "<td>" + _feature_set_inline(graph, key) + "</td>" + configuration_column + "</tr>"
         )
     body.append("</tbody></table></section>")
     # Option metadata are documentation of each resolved build, not extra feature axes.

{cpdocs-0.3.8 → cpdocs-0.3.9}/test/test_language_configurations.py

@@ -68,13 +68,14 @@ Path(output).write_text(json.dumps(data), encoding='utf-8')
 """,
         encoding="utf-8",
     )
-    command = shlex.quote(sys.executable) + ' language_provider.py'
+    command = shlex.quote(sys.executable) + " language_provider.py"
     (project / "docs" / "cpdocs.yml").write_text(
-        "contract: 3\nlanguages:\n" + expression
+        "contract: 3\nlanguages:\n"
+        + expression
         + "build:\n"
-        + f'  feature-sets: >-\n    {command} feature-sets '
+        + f"  feature-sets: >-\n    {command} feature-sets "
         + '"{{cxx.standard}}" "{{python.version}}" "{{output-file}}"\n'
-        + f'  build: >-\n    {command} build '
+        + f"  build: >-\n    {command} build "
         + '"{{cxx.standard}}" "{{python.version}}" "{{output-file}}" "{{feature-set}}"\n',
         encoding="utf-8",
     )
@@ -91,18 +92,22 @@ def test_explicit_keyso_pairs_and_variant_feature_discovery(tmp_path: Path) -> N
     )
     graph = build_current(load_config(project / "docs/cpdocs.yml"), output=project / "build")
     assert len(graph.feature_sets) == 3  # one feature set for C++17, two for C++23
-    records = [json.loads(line) for line in (project / "build-records.jsonl").read_text().splitlines()]
-    assert {(item["cxx"], item["python"]) for item in records} == {
-        ("17", "3.11"), ("23", "3.12")
-    }
+    records = [
+        json.loads(line) for line in (project / "build-records.jsonl").read_text().splitlines()
+    ]
+    assert {(item["cxx"], item["python"]) for item in records} == {("17", "3.11"), ("23", "3.12")}
     assert len([item for item in records if item["phase"] == "feature-sets"]) == 2
     assert len([item for item in records if item["phase"] == "build"]) == 3
     configurations = {key: data["languages"] for key, data in graph.feature_sets.items()}
     assert {entry["cxx"]["standard"] for entry in configurations.values()} == {17, 23}
     assert len({key for key in graph.feature_sets}) == 3
     for language in ("language-001", "language-002"):
-        assert (project / "build/cpdocs/work/current/language-configurations" / language
-                / "feature-sets/feature-sets.json").exists()
+        assert (
+            project
+            / "build/cpdocs/work/current/language-configurations"
+            / language
+            / "feature-sets/feature-sets.json"
+        ).exists()
     feature_page = (project / "build/cpdocs/current/feature-sets/index.html").read_text()
     assert "cxx.standard=17" in feature_page
     assert "cxx.standard=23" in feature_page