Add a format choice

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

src/scikit_build_core/settings/documentation.py

@@ -62,7 +62,7 @@ class DCDoc:
 
     def __str__(self) -> str:
         docs = "\n".join(f"# {s}" for s in textwrap.wrap(self.docs, width=78))
-        return f"{docs}\n{self.name} = {self.default}\n"
+        return f"{docs}\n{self.name} = {self.default}"
 
 
 def get_metadata_field(field: dataclasses.Field[U], field_name: str, default: T) -> T:

src/scikit_build_core/settings/skbuild_docs.py

@@ -1,23 +1,48 @@
 from __future__ import annotations
 
+import textwrap
+from typing import TYPE_CHECKING
+
 from .documentation import mk_docs
 from .skbuild_model import ScikitBuildSettings
 
+if TYPE_CHECKING:
+    from typing import Literal
+
 __all__ = ["mk_skbuild_docs"]
 
 
 def __dir__() -> list[str]:
     return __all__
 
 
-def mk_skbuild_docs() -> str:
+FORMATS = {
+    "readme": textwrap.dedent("""\
+    {item}
+    """),
+}
+
+
+def mk_skbuild_docs(output_format: Literal["readme"] = "readme") -> str:
     """
     Makes documentation for the skbuild model.
     """
-    return "\n".join(
-        str(item) for item in mk_docs(ScikitBuildSettings) if not item.deprecated
-    )
+    items = list(mk_docs(ScikitBuildSettings))
+    # Filter deprecated fields
+    if output_format == "readme":
+        items = [item for item in items if not item.deprecated]
+    return "\n".join(FORMATS[output_format].format(item=item) for item in items)
 
 
 if __name__ == "__main__":
-    print(mk_skbuild_docs())  # noqa: T201
+    import argparse
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--format",
+        default="readme",
+        choices=["readme"],
+        help="Output format",
+    )
+    args = parser.parse_args()
+    print(mk_skbuild_docs(args.format))  # noqa: T201