cpdocs 0.3.3__tar.gz → 0.3.4__tar.gz

{cpdocs-0.3.3 → cpdocs-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cpdocs
-Version: 0.3.3
+Version: 0.3.4
 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.3 → cpdocs-0.3.4}/src/cpdocs/__init__.py

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

{cpdocs-0.3.3 → cpdocs-0.3.4}/src/cpdocs/languages/python/extract.py

@@ -15,7 +15,14 @@ import ast
 import inspect
 from pathlib import Path
 
-from ...model import ApiEntity, ApiGraph, ApiParameter, ApiSignature, SourceLocation, stable_entity_id
+from ...model import (
+    ApiEntity,
+    ApiGraph,
+    ApiParameter,
+    ApiSignature,
+    SourceLocation,
+    stable_entity_id,
+)
 
 
 def _annotation(node: ast.expr | None) -> str:

{cpdocs-0.3.3 → cpdocs-0.3.4}/src/cpdocs/languages/rust/extract.py

@@ -9,7 +9,14 @@ from __future__ import annotations
 import json
 from pathlib import Path
 
-from ...model import ApiEntity, ApiGraph, ApiParameter, ApiSignature, SourceLocation, stable_entity_id
+from ...model import (
+    ApiEntity,
+    ApiGraph,
+    ApiParameter,
+    ApiSignature,
+    SourceLocation,
+    stable_entity_id,
+)
 
 _KIND_MAP = {
     "module": "module",

{cpdocs-0.3.3 → cpdocs-0.3.4}/src/cpdocs/rendering/html.py

@@ -49,7 +49,6 @@ from .common import (
     entity_document,
 )
 
-
 _INLINE_DOCUMENTATION = re.compile(
     r"`(?P<code>[^`]+)`"
     r"|\*\*(?P<strong>[^*\n]+?)\*\*"

{cpdocs-0.3.3 → cpdocs-0.3.4}/test/test_contract.py

@@ -188,15 +188,23 @@ def test_browse_only_unit_may_have_no_language(tmp_path: Path) -> None:
 
 
 def test_besa_options_metadata_does_not_affect_feature_selection(tmp_path):
-    import json
-    from cpdocs.contract import read_manifest
-
     manifest_path = tmp_path / "besa.json"
-    manifest_path.write_text(json.dumps({
-        "cpdocs-manifest": 1,
-        "units": [{"id": "python", "language": "python", "api": [{"path": "."}], "package": "fixture"}],
-        "options": [{"name": "BUILD_WARNINGS", "group": "build", "value": "extra;werror"}],
-    }))
+    manifest_path.write_text(
+        json.dumps(
+            {
+                "cpdocs-manifest": 1,
+                "units": [
+                    {
+                        "id": "python",
+                        "language": "python",
+                        "api": [{"path": "."}],
+                        "package": "fixture",
+                    }
+                ],
+                "options": [{"name": "BUILD_WARNINGS", "group": "build", "value": "extra;werror"}],
+            }
+        )
+    )
     manifest = read_manifest(manifest_path, source=tmp_path)
     assert len(manifest.units) == 1
     assert manifest.options[0]["value"] == "extra;werror"

{cpdocs-0.3.3 → cpdocs-0.3.4}/src/cpdocs/cli.py

@@ -12,10 +12,10 @@ from pathlib import Path
 from . import __version__
 from .build import build_current, build_versions
 from .config import DEFAULT_CONFIG, load_config
-from .providers.python import write_feature_sets as write_python_feature_sets
-from .providers.python import write_manifest as write_python_manifest
 from .providers.cargo import write_feature_sets as write_rust_feature_sets
 from .providers.cargo import write_manifest as write_rust_manifest
+from .providers.python import write_feature_sets as write_python_feature_sets
+from .providers.python import write_manifest as write_python_manifest
 
 
 def _path(value: str) -> Path:

{cpdocs-0.3.3 → cpdocs-0.3.4}/test/test_api_reference.py

@@ -10,9 +10,10 @@ from pathlib import Path
 
 import pytest
 
-from cpdocs.languages.cpp.extract import extract_clang_graph
 from cpdocs.contract import ParseOptions
-from cpdocs.rendering.html import render_html_site
+from cpdocs.languages.cpp.extract import extract_clang_graph
+from cpdocs.languages.python.extract import build_python_graph
+from cpdocs.languages.rust.extract import build_rust_graph
 from cpdocs.model import (
     ApiAttribute,
     ApiEntity,
@@ -22,9 +23,8 @@ from cpdocs.model import (
     merge_graphs,
     stable_entity_id,
 )
-from cpdocs.languages.python.extract import build_python_graph
 from cpdocs.rendering.common import entity_document
-from cpdocs.languages.rust.extract import build_rust_graph
+from cpdocs.rendering.html import render_html_site
 
 
 def test_cpp_semantic_profiles_merge_conditional_api(tmp_path: Path) -> None:

{cpdocs-0.3.3 → cpdocs-0.3.4}/test/test_rust_provider.py

@@ -179,8 +179,8 @@ def test_rust_cli_provider_uses_cargo_metadata_and_nightly_rustdoc(
 
 
 def test_rustdoc_backend_keeps_local_public_api_and_default_public_members(tmp_path: Path) -> None:
-    from cpdocs.model import stable_entity_id
     from cpdocs.languages.rust.extract import build_rust_graph
+    from cpdocs.model import stable_entity_id
 
     rustdoc = tmp_path / "rustdoc.json"
     rustdoc.write_text(
@@ -240,8 +240,8 @@ def test_rustdoc_backend_keeps_local_public_api_and_default_public_members(tmp_p
 
 
 def test_rustdoc_backend_uses_semantic_owners_for_fields_and_impl_items(tmp_path: Path) -> None:
-    from cpdocs.model import stable_entity_id
     from cpdocs.languages.rust.extract import build_rust_graph
+    from cpdocs.model import stable_entity_id
 
     rustdoc = tmp_path / "rustdoc.json"
     rustdoc.write_text(