Improve cli documenation (#5818)

* refactor: create `get_parser()`

* test

* markdown renderer for argparse commands

* enhance cli documentation

* enable CI workflows

* generate controls overview and link stylesheet

* apply review suggestions

* add flet-cli in pyproject.toml

* improve render_controls_overview

Author: ndonkoHenri

sdk/python/packages/flet-cli/src/flet_cli/cli.py

@@ -60,8 +60,11 @@ def set_default_subparser(
         args.insert(index, name)
 
 
-def main():
+def get_parser() -> argparse.ArgumentParser:
+    """Construct and return the CLI argument parser."""
     parser = argparse.ArgumentParser()
+
+    # add version flag
     parser.add_argument(
         "--version",
         "-V",
@@ -71,19 +74,24 @@ def main():
 
     sp = parser.add_subparsers(dest="command")
 
+    # register subcommands
     flet_cli.commands.create.Command.register_to(sp, "create")
     flet_cli.commands.run.Command.register_to(sp, "run")
     flet_cli.commands.build.Command.register_to(sp, "build")
     flet_cli.commands.pack.Command.register_to(sp, "pack")
     flet_cli.commands.publish.Command.register_to(sp, "publish")
     flet_cli.commands.serve.Command.register_to(sp, "serve")
-    flet_cli.commands.doctor.Command.register_to(
-        sp, "doctor"
-    )  # Register the doctor command
+    flet_cli.commands.doctor.Command.register_to(sp, "doctor")
 
     # set "run" as the default subparser
     set_default_subparser(parser, name="run", index=1)
 
+    return parser
+
+
+def main():
+    parser = get_parser()
+
     # print usage/help if called without arguments
     if len(sys.argv) == 1:
         parser.print_help(sys.stdout)

sdk/python/packages/flet-cli/src/flet_cli/commands/base.py

@@ -1,5 +1,5 @@
 import argparse
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 from flet_cli.commands.options import Option, verbose_option
 
@@ -13,7 +13,7 @@ class BaseCommand:
     description: Optional[str] = None
     # A list of pre-defined options which will be loaded on initializing
     # Rewrite this if you don't want the default ones
-    arguments: List[Option] = [verbose_option]
+    arguments: list[Option] = [verbose_option]
 
     def __init__(self, parser: argparse.ArgumentParser) -> None:
         for arg in self.arguments:
@@ -25,14 +25,15 @@ def register_to(
         cls,
         subparsers: argparse._SubParsersAction,
         name: Optional[str] = None,
-        **kwargs: Any
+        **kwargs: Any,
     ) -> None:
         """Register a subcommand to the subparsers,
         with an optional name of the subcommand.
         """
         help_text = cls.description or cls.__doc__
         name = name or cls.name or ""
-        # Remove the existing subparser as it will raises an error on Python 3.11+
+
+        # Remove the existing subparser as it will raise an error on Python 3.11+
         subparsers._name_parser_map.pop(name, None)
         subactions = subparsers._get_subactions()
         subactions[:] = [action for action in subactions if action.dest != name]