!56 docs(Probely CLI): [#40] Add first iteration docs Closes #40

Author: João Silva

docs/cli.rst

@@ -0,0 +1,8 @@
+Findings
+========
+
+.. sphinx-argparse-cli::
+    :module: probely.cli.parsers.findings_parsers
+    :func: build_findings_parser
+    :prog: probely findings
+    :no_default_values:

docs/findings.rst

@@ -1,18 +1,19 @@
 Welcome to Probely's documentation!
 ===================================
 
-SDK and CLI
+CLI
 
 .. note::
 
-   This project is under active development.
+    This project is under active development.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+    :maxdepth: 2
+    :caption: Contents:
 
-   sdk
-   cli
+    targets
+    scans
+    findings
 
 Indices and tables
 ==================

docs/index.rst

@@ -0,0 +1,8 @@
+Scans
+=====
+
+.. sphinx-argparse-cli::
+    :module: probely.cli.parsers.scans_parsers
+    :func: build_scans_parser
+    :prog: probely scans
+    :no_default_values:

docs/scans.rst

@@ -0,0 +1,8 @@
+Targets
+=======
+
+.. sphinx-argparse-cli::
+    :module: probely.cli.parsers.targets_parsers
+    :func: build_targets_parser
+    :prog: probely targets
+    :no_default_values:

docs/sdk.rst

@@ -5,7 +5,7 @@
 from rich.console import Console
 
 from .app import CLIApp
-from .commands.parsers import build_cli_parser
+from .parsers.base_parser import build_cli_parser
 
 logger = logging.getLogger(__name__)
 

docs/targets.rst

@@ -12,11 +12,6 @@
 from probely.exceptions import ProbelyCLIValidation
 
 
-def show_help(args):
-    if args.is_no_action_parser:
-        args.parser.print_help()
-
-
 def validate_and_retrieve_yaml_content(yaml_file_path: Union[str, None]):
     if not yaml_file_path:
         return dict()