diff --git a/README.md b/README.md index 2fea064..dbc44d9 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ testdoc suite_directory output.html testdoc suite_file output.html ``` +![General Usage](./docs/gifs/general_usage.gif) + ### Extended Usage ```shell testdoc [OPTIONS] suite_directory output.html @@ -51,6 +53,18 @@ You have two option to use it this way: For further details about the usage, please read the [official documentation](https://marvkler.github.io/robotframework-testdoc/usage). +#### Use customized Jinja2 Template + +![Custom Jinja Template](./docs/gifs/customjinja.gif) + +#### Use internal Mkdocs Template + +![Internal Mkdocs Template](./docs/gifs/mkdocs_internal_template.gif) + +#### Use customized Mkdocs Template + +![Custom Mkdocs Template](./docs/gifs/mkdocs_custom_template.gif) + ## Examples Visit the official documentation to find some [Examples](https://marvkler.github.io/robotframework-testdoc/usage/#examples). diff --git a/docs/gifs/customjinja.gif b/docs/gifs/customjinja.gif new file mode 100644 index 0000000..f9970d6 Binary files /dev/null and b/docs/gifs/customjinja.gif differ diff --git a/docs/gifs/general_usage.gif b/docs/gifs/general_usage.gif new file mode 100644 index 0000000..05b799a Binary files /dev/null and b/docs/gifs/general_usage.gif differ diff --git a/docs/gifs/mkdocs_custom_template.gif b/docs/gifs/mkdocs_custom_template.gif new file mode 100644 index 0000000..b332de7 Binary files /dev/null and b/docs/gifs/mkdocs_custom_template.gif differ diff --git a/docs/gifs/mkdocs_internal_template.gif b/docs/gifs/mkdocs_internal_template.gif new file mode 100644 index 0000000..ca21c2f Binary files /dev/null and b/docs/gifs/mkdocs_internal_template.gif differ diff --git a/docs/mkdocs/docs/index.md b/docs/mkdocs/docs/index.md index 79c6aa4..91be8d0 100644 --- a/docs/mkdocs/docs/index.md +++ b/docs/mkdocs/docs/index.md @@ -16,6 +16,14 @@ Use the following command to install the tool: pip install robotframework-testdoc ``` +## :material-test-tube: Simple Usage + +```shell +testdoc atest/testdata/acceptance output.html +``` + +![General Usage](./stylesheets/general_usage.gif) + ## :material-test-tube: Examples Visit the [Examples](gettingstarted.md) page for some demo use cases & insights of what the tool is capable of! diff --git a/docs/mkdocs/docs/stylesheets/customjinja.gif b/docs/mkdocs/docs/stylesheets/customjinja.gif new file mode 100644 index 0000000..f9970d6 Binary files /dev/null and b/docs/mkdocs/docs/stylesheets/customjinja.gif differ diff --git a/docs/mkdocs/docs/stylesheets/general_usage.gif b/docs/mkdocs/docs/stylesheets/general_usage.gif new file mode 100644 index 0000000..05b799a Binary files /dev/null and b/docs/mkdocs/docs/stylesheets/general_usage.gif differ diff --git a/docs/mkdocs/docs/stylesheets/mkdocs_custom_template.gif b/docs/mkdocs/docs/stylesheets/mkdocs_custom_template.gif new file mode 100644 index 0000000..b332de7 Binary files /dev/null and b/docs/mkdocs/docs/stylesheets/mkdocs_custom_template.gif differ diff --git a/docs/mkdocs/docs/stylesheets/mkdocs_internal_template.gif b/docs/mkdocs/docs/stylesheets/mkdocs_internal_template.gif new file mode 100644 index 0000000..ca21c2f Binary files /dev/null and b/docs/mkdocs/docs/stylesheets/mkdocs_internal_template.gif differ diff --git a/docs/mkdocs/docs/usage/jinja2.md b/docs/mkdocs/docs/usage/jinja2.md index 97e5db6..db56309 100644 --- a/docs/mkdocs/docs/usage/jinja2.md +++ b/docs/mkdocs/docs/usage/jinja2.md @@ -35,6 +35,8 @@ testdoc --custom-jinja-template /my_jinja2_template.html suite_directory o !!! tip "Example" Please take a look at the [Internal Jinja2 Template](https://github.com/MarvKler/robotframework-testdoc/blob/main/src/testdoc/html/templates/v2/jinja_template_03.html) to get an idea about using the provided metadata by ``testdoc``! +![Jinja Usage](../stylesheets/customjinja.gif) + ## Open Jinja2 Webpages You can simply open the defined output HTML file in any browser on your local system. Jinja2 generates a static HTML pages without any dependecies. diff --git a/docs/mkdocs/docs/usage/mkdocs.md b/docs/mkdocs/docs/usage/mkdocs.md index ef2e3d6..7515688 100644 --- a/docs/mkdocs/docs/usage/mkdocs.md +++ b/docs/mkdocs/docs/usage/mkdocs.md @@ -18,6 +18,8 @@ testdoc --mkdocs You can take a look at the internal mkdocs template provided by ``robotframework-testdoc`` - here you can find it: [Internal Mkdocs Template](https://github.com/MarvKler/robotframework-testdoc/tree/main/src/testdoc/html/templates/mkdocs_default) +![Mkdocs Internal Usage](../stylesheets/mkdocs_internal_template.gif) + ## External Mkdocs Template You can also created your own ``mkdocs`` template locally which will be used by ``robotframework-testdoc`` as base template & gets extended with the given test suite directory. @@ -34,6 +36,8 @@ testdoc --mkdocs --mkdocs-template-dir None: shutil.copyfile(src, dst) def _mkdocs_build(self, work_dir: Path) -> None: - subprocess.check_call(["mkdocs", "build", "-f", str(work_dir / "mkdocs.yml")]) + cmd = ["mkdocs", "build", "-f", str(work_dir / "mkdocs.yml")] + if not self.args.verbose_mode: + cmd.append("--quiet") + subprocess.check_call(cmd) Logger().Log("---------------------------------------------------------------------------", "green") Logger().Log("Generated mkdocs pages here:", "green") Logger().Log(work_dir)