add mkdocs to cli

Author: mustafasoylu

src/somesy/cli/init.py

@@ -78,6 +78,12 @@ def config():
     if pom_xml_file := typer.prompt("pom.xml file path", default="pom.xml"):
         options["pom_xml_file"] = pom_xml_file
 
+    options["no_sync_mkdocs"] = not typer.confirm(
+        "Do you want to sync to a mkdocs.yml file?", default=True
+    )
+    if mkdocs_file := typer.prompt("mkdocs.yml file path", default="mkdocs.yml"):
+        options["mkdocs_file"] = mkdocs_file
+
     # ----
 
     options["show_info"] = typer.confirm(

src/somesy/cli/sync.py

@@ -94,6 +94,19 @@ def sync(
         help="Custom pom.xml (Java Maven) file path (default: pom.xml)",
         **existing_file_arg_config,
     ),
+    no_sync_mkdocs: bool = typer.Option(
+        None,
+        "--no-sync-mkdocs",
+        "-X",
+        help="Do not sync mkdocs.yml file (default: False)",
+    ),
+    mkdocs_file: Path = typer.Option(
+        None,
+        "--mkdocs-file",
+        "-x",
+        help="Custom mkdocs.yml file path (default: mkdocs.yml)",
+        **existing_file_arg_config,
+    ),
     no_sync_cff: bool = typer.Option(
         None,
         "--no-sync-cff",
@@ -138,6 +151,8 @@ def sync(
         fortran_file=fortran_file,
         no_sync_pom_xml=no_sync_pom_xml,
         pom_xml_file=pom_xml_file,
+        no_sync_mkdocs=no_sync_mkdocs,
+        mkdocs_file=mkdocs_file,
     )
     run_sync(somesy_input)
 
@@ -167,6 +182,10 @@ def run_sync(somesy_input: SomesyInput):
         logger.info(
             f"  - [italic]pom.xml[/italic]:\t[grey]{conf.pom_xml_file}[/grey]\n"
         )
+    if not conf.no_sync_mkdocs:
+        logger.info(
+            f"  - [italic]mkdocs.yml[/italic]:\t[grey]{conf.mkdocs_file}[/grey]"
+        )
 
     if not conf.no_sync_cff:
         logger.info(f"  - [italic]CITATION.cff[/italic]:\t[grey]{conf.cff_file}[/grey]")

src/somesy/commands/sync.py

@@ -11,6 +11,7 @@
 from somesy.core.writer import ProjectMetadataWriter
 from somesy.fortran.writer import Fortran
 from somesy.julia.writer import Julia
+from somesy.mkdocs import MkDocs
 from somesy.package_json.writer import PackageJSON
 from somesy.pom_xml.writer import POM
 from somesy.pyproject.writer import Pyproject
@@ -54,8 +55,10 @@ def sync(somesy_input: SomesyInput):
     if conf.pom_xml_file.is_file() and not conf.no_sync_pom_xml:
         _sync_file(metadata, conf.pom_xml_file, POM)
 
-    # create these by default if they are missing:
+    if conf.mkdocs_file.is_file() and not conf.no_sync_mkdocs:
+        _sync_file(metadata, conf.mkdocs_file, MkDocs)
 
+    # create these by default if they are missing:
     if not conf.no_sync_cff:
         _sync_file(metadata, conf.cff_file, CFF)
 

src/somesy/core/models.py

@@ -128,6 +128,7 @@ def model_dump_json(self, *args, **kwargs):
     "julia",
     "fortran",
     "pom_xml",
+    "mkdocs",
 ]
 
 
@@ -201,6 +202,13 @@ def at_least_one_target(cls, values):
         "pom.xml"
     )
 
+    no_sync_mkdocs: Annotated[
+        bool, Field(description="Do not sync with mkdocs.yml.")
+    ] = False
+    mkdocs_file: Annotated[Path, Field(description="mkdocs.yml file path.")] = Path(
+        "mkdocs.yml"
+    )
+
     no_sync_cff: Annotated[bool, Field(description="Do not sync with CFF.")] = False
     cff_file: Annotated[Path, Field(description="CFF file path.")] = Path(
         "CITATION.cff"