robotframework-testdoc 0.1.2__py3-none-any.whl

robotframework_testdoc-0.1.2.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: robotframework-testdoc
+Version: 0.1.2
+Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
+Author-email: Marvin Klerx <marvinklerx1@gmail.com>
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: robotframework
+Requires-Dist: jinja2
+Requires-Dist: tomli
+Dynamic: license-file
+
+# Robot Framework TestDoc
+
+## Installation
+
+Install the tool using the following command:
+```shell
+pip install robotframework-testdoc
+```
+
+> [!IMPORTANT]
+> Preconditions: Python & Pip Installation.
+
+## Usage
+
+### Basic Usage
+```shell
+testdoc suite_directory output.html
+# or
+testdoc suite_file output.html
+```
+
+### Extended Usage
+```shell
+testdoc [OPTIONS] suite_directory output.html
+```
+
+> [!TIP]
+> **Included Help:** Please execute ``testdoc --help`` for further details about the commandline arguments or see the examples below.
+
+## Examples
+
+Below you can find some example of using the testdoc library.  
+
+> [!TIP]
+> Of course, you can combine all of them!
+
+```shell
+# Generating docu without option
+testdoc tests/ TestDocumentation.html
+
+# Generating docu with new title, new root suite name, new root suite documentation text & new metadata
+testdoc -t "Robot Framework Test Automation" -n "System Tests" -d "Root Suite Documentation" -m "Root Suite Metadata" tests/ TestDocumentation.html
+
+# Generating docu with source prefix to navigate directly to its gitlab file path
+testdoc -s "https://gitlab.com/myrepository" tests/ TestDocumentation.html
+
+# Generating docu only with specific mentioned tags to include & exclude 
+testdoc -i ManagementUI -e LongTime tests/ TestDocumentation.html
+
+# Generating docu only with multiple specific mentioned tags to include
+testdoc -i ManagementUI -i MQTT tests/ TestDocumentation.html
+
+# Generating docu only with new metadata for root suite object
+testdoc -m Version=0.1.1-dev -m Tester=RobotExpert tests/ TestDocumentation.html
+
+# Generating docu - hide tags information
+testdoc --hide-tags tests/ TestDocumentation.html
+
+# Generating docu - hide test case documentation texts
+testdoc --hide-test-doc tests/ TestDocumentation.html
+
+# Generating docu - hide test suite documentation texts
+testdoc --hide-suite-doc tests/ TestDocumentation.html
+
+# Generating docu - hide source information
+testdoc --hide-source tests/ TestDocumentation.html
+
+# Generating docu - hide keyword information (keyword calls in tests)
+testdoc --hide-keywords tests/ TestDocumentation.html
+```
+
+## Robot Framework Tags
+The commandline arguments ``include`` & ``exclude`` have more or less the same functionality like in the known ``robot ...`` command.     
+You can decide to weither include and / or exclude specific test cases into the test documentation.
+
+## External Configuration File
+The idea of the external configuration file is, having a central place for passing the known CMD arguments via file instead of CMD parameters.   
+This will keep your CMD line call simple & clean.
+
+For using this config file, just call the following command:
+```shell
+# Generate docu with options defined in TOML file
+testdoc -c path/to/config.toml tests/ TestDocumentation.html
+```
+
+## Theme Selection / Color Configuration
+
+You can select between several themes (color configurations) for your HTML document to create!
+
+> [!CAUTION]
+> This is only possible via toml-configuration file, but not via cmd args directly!
+
+### Default Themes
+
+There are a few predefined default themes available that you can choose via the toml-configuration file.   
+Therefore, please use the following syntax:
+```toml
+[colors]
+# Use the default theme
+default = "default"
+default = 0
+# Use the default theme
+default = "dark"
+default = 1
+# Use the default theme
+default = "blue"
+default = 2
+# Use the default theme
+default = "robot"
+default = 3
+```
+
+> [!TIP]
+> You can select the default theme using either a string value or an integer value.
+
+### Custom Themes
+
+You can apply your own custom theme to modify the colors of the created HTML document.   
+Use the following syntax & parameters in your toml-configuration file, to overwrite the predefined themes:
+```toml
+[colors]
+background = "#000028"
+inner_color = "#000028"
+button_active_color = "#193966"
+button_hover_color = "#193966"
+border_color = "#CCCCCC"
+text_color = "#CCCCCC"
+title_color = "#00ffb9"
+robot_icon = "#00ffb9"
+```
+
+> [!TIP]
+> Please make sure to configure all available color values from this example — missing values may cause layout or rendering issues in the generated HTML document!

robotframework_testdoc-0.1.2.dist-info/RECORD

@@ -0,0 +1,24 @@
+robotframework_testdoc-0.1.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+testdoc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+testdoc/__main__.py,sha256=FXuSYwSHojtkWAz8l6xeETxklc3cVdUBqo1GiBGt2Rg,66
+testdoc/cli.py,sha256=VOpy3jPHQVNgwGBQgQmXcgYAeQRsjhgrnzOsJKwSsyM,4441
+testdoc/testdoc.py,sha256=cVJguXoFhkCM2nkUlZGB8m-6rBhKwthFFtdtz0T2l4Q,772
+testdoc/helper/cliargs.py,sha256=PYz6hcKTo-MLzmXWum4foszuHhYrMubAG7nP9xKZ5b8,1263
+testdoc/helper/datetimeconverter.py,sha256=1IuJ_rZlKKut3pallS9WSdlQ00YNQX2Nhf2oYWt7QDc,159
+testdoc/helper/logger.py,sha256=STPEEdMIGpK004xHDskj8zzW3knBWP05GllYajQMaSY,272
+testdoc/helper/pathconverter.py,sha256=Il4SX8EdpKPjOiZt97zC4TBLxp2tKUhfyyS2J1qWpyg,1656
+testdoc/html/images/robotframework.svg,sha256=w1yNL6XtuHOCCwzjGX3pZQG7ZcJghzllvc7cQ9MKKbQ,1426
+testdoc/html/templates/jinja_template_01.html,sha256=gw2hEx2P7zLsQP5-4fA2hErWJuhkUTZkEakXxRzWKtU,18213
+testdoc/html/themes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+testdoc/html/themes/theme_config.py,sha256=UHqNlkff5Q_68uRAsCIODflxJxmLSyH8LMbdJXkHSdw,849
+testdoc/html/themes/themes.py,sha256=6xlHW7O-XO9Z1B33_aRwzffkuWR65jM7CYXsZWUjdmY,1091
+testdoc/html_rendering/render.py,sha256=BzPGyePwjCFZAXRHDF-ccM2xRKY-6Cnym1-uDb9i1AQ,1083
+testdoc/parser/testcaseparser.py,sha256=4EyUFOuo6AtobKN7jveWAXTTs-KlvhzqXQuXnseTGj0,1189
+testdoc/parser/testsuiteparser.py,sha256=F4zWTw4_ccipoOnRHl3LDLn6qPO-AhkSx7cZ7DLKC8U,2381
+testdoc/parser/modifier/sourceprefixmodifier.py,sha256=UUZ0Gp5hZIYv4dvZV6XUOE5UkIFONLFj_mZczC40mzI,3013
+testdoc/parser/modifier/suitefilemodifier.py,sha256=VA-4rAniQugXefWfXSaZoDzOafqXTqGDKLk2BZd6_hE,5785
+robotframework_testdoc-0.1.2.dist-info/METADATA,sha256=9ulen0HLpVJahfcjKaC3k4WVDUvHsu8Kl4D4N2Clm4I,4577
+robotframework_testdoc-0.1.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+robotframework_testdoc-0.1.2.dist-info/entry_points.txt,sha256=BUHy23mdlGCqYOWpsvRhSb1c0tPMzIwyTwr-sHI6xUs,45
+robotframework_testdoc-0.1.2.dist-info/top_level.txt,sha256=p1axpYooAmdwwXQOzFsSXF3u_-88QFKCDxPf67siv3Y,8
+robotframework_testdoc-0.1.2.dist-info/RECORD,,

robotframework_testdoc-0.1.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

robotframework_testdoc-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+testdoc = testdoc.cli:main

robotframework_testdoc-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

robotframework_testdoc-0.1.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+testdoc

testdoc/__main__.py

@@ -0,0 +1,3 @@
+from testdoc.cli import main
+if __name__ == "__main__":
+    main()

testdoc/cli.py

@@ -0,0 +1,91 @@
+import click
+import os
+
+from .testdoc import TestDoc
+from .helper.cliargs import CommandLineArguments
+
+@click.command()
+@click.option("-t","--title",       required=False, help="Modify the title of the test documentation page")
+@click.option("-n","--name",        required=False, help="Modify the name of the root suite element")
+@click.option("-d","--doc",         required=False, help="Modify the documentation of the root suite element")
+@click.option("-m","--metadata",    multiple=True, required=False, help="Modify the metadata of the root suite element")
+@click.option("-s","--sourceprefix",required=False, help=(
+    "Set a prefix used for Test Suite / Test Suite Source Information, e.g. GitLab Prefix Path to navigate directly to your repository!"
+))
+@click.option("-i","--include",     multiple=True, required=False, help="Include test cases with given tags")
+@click.option("-e","--exclude",     multiple=True, required=False, help="Exclude test cases with given tags")
+@click.option("--hide-tags",        is_flag=True, required=False, help="If given, test case tags are hidden")
+@click.option("--hide-test-doc",    is_flag=True,required=False, help="If given, test documentation is hidden")
+@click.option("--hide-suite-doc",   is_flag=True, required=False, help="If given, suite documentation is hidden")
+@click.option("--hide-source",      is_flag=True, required=False, help="If given, test suite/ test case source is hidden")
+@click.option("--hide-keywords",    is_flag=True, required=False, help="If given, keyword calls in test cases are hidden")
+@click.option("-c", "--configfile", required=False, help="Optional .toml configuration file (includes all cmd-args)")
+@click.option("-v", "--verbose",    is_flag=True, required=False, help="More precise debugging into shell")
+@click.argument("PATH")
+@click.argument("OUTPUT")
+def main(
+        title,
+        name,
+        doc,
+        metadata,
+        sourceprefix,
+        include,
+        exclude,
+        hide_tags,
+        hide_test_doc,
+        hide_suite_doc,
+        hide_source,
+        hide_keywords,
+        configfile,
+        verbose,
+        path,
+        output,
+    ):
+    """
+    Welcome to robotframework-testdoc - the new test documentation generator for your Robot Framework tests!
+    """
+    color = "green"
+    click.echo(click.style("""
+████████╗███████╗███████╗████████╗██████╗ ███████╗███████╗
+╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝██   ██╗██   ██║██╔════╝
+   ██║   █████╗  ███████╗   ██║   ██   ██║██   ██║██║     
+   ██║   ██╔══╝  ╚════██║   ██║   ██   ██║██   ██║██║       
+   ██║   ███████╗███████║   ██║   ██████╔╝███████║███████╗
+   ╚═╝   ╚══════╝╚══════╝   ╚═╝   ╚═════╝ ╚══════╝ ╚═════╝  
+      """, fg=color)
+    )
+
+    args_instance = CommandLineArguments()
+    if configfile:
+        if os.path.exists(configfile):
+            args_instance.load_from_config_file(configfile)
+        else:
+            click.echo(click.style(f"⚠️ Config File not found: {configfile}", fg="yellow"))
+
+    args = args_instance.data
+    cli_params = {
+        "title": title or None,
+        "name": name or None,
+        "doc": doc or None,
+        "metadata": dict(item.split("=", 1) for item in metadata) if metadata else None,
+        "sourceprefix": sourceprefix,
+        "include": list(include) if include else None,
+        "exclude": list(exclude) if exclude else None,
+        "hide_tags": hide_tags or None,
+        "hide_test_doc": hide_test_doc or None,
+        "hide_suite_doc": hide_suite_doc or None,
+        "hide_source": hide_source or None,
+        "hide_keywords": hide_keywords or None,
+        "verbose_mode": verbose or None,
+        "config_file": configfile or None,
+    }
+    args.suite_file = path
+    args.output_file = output
+
+    for key, value in cli_params.items():
+        if value is not None:
+            setattr(args, key, value)    
+    TestDoc().main()
+
+if __name__ == "__main__":
+    main()

testdoc/helper/cliargs.py

@@ -0,0 +1,43 @@
+from dataclasses import dataclass, field
+from typing import List
+import tomli
+
+@dataclass
+class CommandLineArgumentsData:
+    title: str = "Robot Framework - Test Documentation"
+    name: str = None
+    doc: str = None
+    metadata: dict = None
+    sourceprefix: str = None
+    include: List[str] = field(default_factory=list)
+    exclude: List[str] = field(default_factory=list)
+    hide_tags: bool = False
+    hide_test_doc: bool = False
+    hide_suite_doc: bool = False
+    hide_source: bool = False
+    hide_keywords: bool = False
+    config_file: str = None
+    verbose_mode: bool = False
+    suite_file: str = None
+    output_file: str = None
+    colors: dict = None
+
+class CommandLineArguments:
+    _instance = None
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+            
+            cls.data = CommandLineArgumentsData()
+        return cls._instance
+    
+    def load_from_config_file(self, file_path: str):
+        with open(file_path, "rb") as f:
+            config = tomli.load(f)
+
+        if "colors" in config:
+            self.data.colors = config["colors"]
+
+        for key, value in config.items():
+            if hasattr(self.data, key):
+                setattr(self.data, key, value)

testdoc/helper/datetimeconverter.py

@@ -0,0 +1,5 @@
+import datetime
+
+class DateTimeConverter():
+    def get_generated_datetime(self) -> str:
+        return(datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

testdoc/helper/logger.py

@@ -0,0 +1,9 @@
+import click
+
+class Logger():
+    def LogKeyValue(self, key, value, color = "green"):
+        click.echo(key, nl=False)
+        click.echo(click.style(f"'{value}'", fg=color))
+        
+    def Log(self, msg, color = "white"):
+        click.echo(click.style(msg, fg=color))

testdoc/helper/pathconverter.py

@@ -0,0 +1,50 @@
+import os
+
+from .cliargs import CommandLineArguments
+from .logger import Logger
+
+class PathConverter():
+
+    def __init__(self):
+        self.args = CommandLineArguments().data
+
+    def path_convertion(self) -> str:
+        
+        suite_path = self.args.suite_file
+        output_path = self.args.output_file
+        config_path = self.args.config_file
+
+        # Convert path to suite file / directory
+        suite_path = PathConverter().conv_generic_path(path=suite_path)
+        if ".robot" in suite_path:
+            msg = f"Suite File: '{str(suite_path).split("/")[-1]}'"
+        else:
+            msg = f"Suite Directory: '{suite_path}'"
+
+        # Convert path to output file
+        output_path = PathConverter().conv_generic_path(path=output_path)
+
+        # Convert path to config file
+        if self.args.config_file:
+            config_path = PathConverter().conv_generic_path(path=config_path)
+
+        # Print to console
+        if self.args.verbose_mode:
+            Logger().Log("=== TestDoc  ===")
+            Logger().LogKeyValue("Generating Test Documentation for: ", msg)
+            Logger().LogKeyValue("Saving to output file: ", output_path)
+            Logger().LogKeyValue("Using config file: ", config_path) if config_path else None
+
+        return suite_path, output_path, config_path
+
+    def conv_generic_path(self,
+            path: str
+        ) -> str:
+        """
+        Generate OS independent path.
+        """
+        abs_path = os.path.abspath(path)
+        generic_path = os.path.normpath(abs_path)
+        if os.name == "nt":
+            generic_path = generic_path.replace("\\", "/")
+        return generic_path

testdoc/html/images/robotframework.svg

@@ -0,0 +1 @@
+<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Robot Framework</title><path d="M4.9565 10.2246c0-1.8766 1.5257-3.4023 3.4-3.4023 1.8766 0 3.4024 1.5257 3.4024 3.4023 0 .6838-.5526 1.2364-1.2341 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364 0-.513-.4185-.9296-.9338-.9296-.5129 0-.9317.4165-.9317.9296 0 .6838-.5523 1.2364-1.234 1.2364-.6818 0-1.2344-.5526-1.2344-1.2364m14.0868 5.717c0 .6842-.5524 1.2363-1.2341 1.2363H6.3575c-.6818 0-1.2344-.552-1.2344-1.2363 0-.6837.5526-1.2363 1.2344-1.2363h11.4517c.6817 0 1.234.5526 1.234 1.2363m-5.351-5.0244c-.3814-.5657-.2323-1.3328.3334-1.7143l2.8628-1.9334c.5613-.3902 1.3329-.2324 1.7144.3289.3815.5654.2323 1.3329-.3334 1.7144l-2.8628 1.9333c-.5442.3831-1.3348.2379-1.7144-.3289zm7.8393 7.6018a.8815.8815 0 0 1-.258.6227l-2.1277 2.1277a.8822.8822 0 0 1-.623.258H5.4772a.8822.8822 0 0 1-.623-.258l-2.1277-2.1277a.8815.8815 0 0 1-.258-.6227V5.4818a.8797.8797 0 0 1 .258-.6228l2.1277-2.1282a.8816.8816 0 0 1 .623-.2578h13.0456a.8816.8816 0 0 1 .623.2578l2.1277 2.1282a.8797.8797 0 0 1 .258.6228V18.519zm1.811-15.0835L20.5644.6577A2.2454 2.2454 0 0 0 18.9775 0H5.0207A2.2445 2.2445 0 0 0 3.433.658L.657 3.4359A2.2449 2.2449 0 0 0 0 5.0228v13.9547c0 .5953.2366 1.1667.6575 1.5872l2.778 2.7779c.421.421.9918.6573 1.5871.6573h13.9548a2.2448 2.2448 0 0 0 1.5872-.6573l2.7779-2.7779A2.2436 2.2436 0 0 0 24 18.9775V5.023a2.2451 2.2451 0 0 0-.6575-1.5875z"/></svg>