fixed

- outdir type error
- exceptions to users

Author: juiwenchen

src/sphinx_codelinks/cmd.py

@@ -63,8 +63,8 @@ def analyse(
 
     data: CodeLinksConfigType = load_config_from_toml(config)
 
-    codelinks_config = CodeLinksConfig(**data)
     try:
+        codelinks_config = CodeLinksConfig(**data)
         generate_project_configs(codelinks_config.projects)
     except TypeError as e:
         raise typer.BadParameter(str(e)) from e
@@ -186,14 +186,14 @@ def load_config_from_toml(toml_file: Path) -> CodeLinksConfigType:
             toml_data = tomllib.load(f)
 
     except Exception as e:
-        raise Exception(
+        raise typer.BadParameter(
             f"Failed to load CodeLinks configuration from {toml_file}"
         ) from e
 
     codelink_dict = toml_data.get("codelinks")
 
     if not codelink_dict:
-        raise Exception(f"No 'codelinks' section found in {toml_file}")
+        raise typer.BadParameter(f"No 'codelinks' section found in {toml_file}")
 
     return cast(CodeLinksConfigType, codelink_dict)
 

src/sphinx_codelinks/config.py

@@ -534,6 +534,9 @@ def __setattr__(self, name: str, value: Any) -> None:  # type: ignore[explicit-a
                 super().__getattribute__("_sphinx_config"), f"src_trace_{name}", value
             )
 
+        if name == "outdir" and isinstance(value, str):
+            # Ensure outdir is a Path object
+            value = Path(value)
         return object.__setattr__(self, name, value)
 
     @classmethod

tests/data/configs/full_config.toml

@@ -0,0 +1,43 @@
+[codelinks]
+# Configuration for source tracing
+set_local_url = true            # Set to true to enable local code html and URL generation
+local_url_field = "local-url"   # Need's field name for local URL
+set_remote_url = true           # Set to true to enable remote url to be generated
+remote_url_field = "remote-url" # Need's field name for remote URL
+outdir = "codelinks_output"     # Output directory for generated files
+
+# Configuration for source tracing project "dcdc"
+[codelinks.projects.dcdc]
+remote_url_pattern = "https://github.com/useblocks/sphinx-codelinks/blob/{commit}/{path}#L{line}" # URL pattern for remote source code
+
+[codelinks.projects.dcdc.source_discover]
+src_dir = "../dcdc"            # Relative path from this TOML config to the source directory
+comment_type = "cpp"
+exclude = []
+include = ["**/*.c", "**/*.h"]
+gitignore = false
+
+[codelinks.projects.dcdc.analyse]
+get_need_id_refs = false
+get_oneline_needs = true
+get_rst = false
+
+[codelinks.projects.dcdc.analyse.oneline_comment_style]
+# Configuration for oneline comment style
+start_sequence = "[["  # Start sequence for oneline comments
+end_sequence = "]]"    # End sequence for the online comments; default is newline character
+field_split_char = "," # Character to split fields in the comment
+# Fields that are defined in the oneline comment style
+needs_fields = [
+  { "name" = "id", "type" = "str" },
+  { "name" = "title", "type" = "str" },
+  { "name" = "type", "type" = "str", "default" = "impl" },
+  { "name" = "links", "type" = "list[str]", "default" = [
+  ] },
+]
+
+[codelinks.projects.src]
+remote_url_pattern = "https://github.com/useblocks/sphinx-codelinks/blob/{commit}/{path}#L{line}"
+
+[codelinks.projects.src.source_discover]
+src_dir = "../doc_test/minimum_config"

tests/data/analyse/minimum_config.toml tests/data/configs/minimum_config.tomltests/data/analyse/minimum_config.toml renamed to tests/data/configs/minimum_config.toml

@@ -1,6 +1,6 @@
 [codelinks.projects.basic.source_discover]
 src_dir = "./"
-comment_type = "c"
+comment_type = "cpp"
 exclude = []
 include = ["**/*.c", "**/*.h"]
 gitignore = false

tests/data/oneline_comment_basic/analyse_config.toml

@@ -1,6 +1,6 @@
 [codelinks.projects.default.source_discover]
 src_dir = "./"
-comment_type = "c"
+comment_type = "cpp"
 exclude = []
 include = ["**/*.c", "**/*.h"]
 gitignore = false

tests/data/oneline_comment_default/analyse_config.toml

@@ -46,7 +46,11 @@
 
 
 @pytest.mark.parametrize(
-    ("config_path"), [(DATA_DIR / "analyse" / "minimum_config.toml")]
+    ("config_path"),
+    [
+        (DATA_DIR / "configs" / "minimum_config.toml"),
+        (DATA_DIR / "configs" / "full_config.toml"),
+    ],
 )
 def test_analyse(config_path: Path, tmp_path: Path) -> None:
     options: list[str] = ["analyse", str(config_path), "--outdir", str(tmp_path)]