robotframework-testdoc 0.5.0__tar.gz → 0.6.0__tar.gz

{robotframework_testdoc-0.5.0 → robotframework_testdoc-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.5.0
+Version: 0.6.0
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
 Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
@@ -89,7 +89,7 @@ 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
+#### Use customized Jinja2 HTML Template
 
 ![Custom Jinja Template](./docs/gifs/customjinja.gif)
 
@@ -132,116 +132,14 @@ doc = "New doc text of root suite element"
 sourceprefix = "gitlab::https://gitlab.com/myrepo/repo_path"
 include = ["TagA", "TagB"]
 exclude = ["TagC"]
-hide_tags = true
-hide_test_doc = true
-hide_suite_doc = true
-hide_source = true
-hide_keywords = true
-style = "blue"
 verbose_mode = false
 
 [tool.testdoc.metadata]
 Author = "Your-Name"
 Version = "1.0.0"
 Source = "AnySourceAsMetaData"
-
-[tool.testdoc.colors]
-# Use predefined theme:
-default = "blue"
-# OR
-# Use custom 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"
-code_area_background = "#303030"
-code_area_foreground = "#f1f1f1"
-```
-
-## 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 OR cli.   
-Therefore, please use the following syntax: for the toml file
-```toml
-[colors]
-# Use the default theme
-default = "default"
-default = 0
-# Use the dark theme
-default = "dark"
-default = 1
-# Use the blue theme
-default = "blue"
-default = 2
-# Use the robot theme
-default = "robot"
-default = 3
-# Use the dark robot theme
-default = "robot_dark"
-default = 4
-# Use the green theme
-default = "green"
-default = 5
 ```
 
-For setting it via CLI, please use the following:
-```shell
-# Applying dark theme
-testdoc ... -S dark PATH OUTPUT_FILE
-
-# Applying blue theme
-testdoc ... --style blue PATH OUTPUT_FILE
-```
-
-> [!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"
-code_area_background = "#303030"
-code_area_foreground = "#f1f1f1"
-```
-
-> [!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!
-
-### Default Themes - Screenshot
-
-#### Dark
-
-![alt text](docs/style_dark.png)
-
-#### Blue
-
-![alt text](docs/style_blue.png)
-
-#### Robot / Default
-
-![alt text](docs/style_robot.png)
-
 ## Contribution & Development
 
 See [Development.md](./DEVELOPMENT.md) for more information about contributing & developing this library.

{robotframework_testdoc-0.5.0 → robotframework_testdoc-0.6.0}/README.md

@@ -53,7 +53,7 @@ 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
+#### Use customized Jinja2 HTML Template
 
 ![Custom Jinja Template](./docs/gifs/customjinja.gif)
 
@@ -96,116 +96,14 @@ doc = "New doc text of root suite element"
 sourceprefix = "gitlab::https://gitlab.com/myrepo/repo_path"
 include = ["TagA", "TagB"]
 exclude = ["TagC"]
-hide_tags = true
-hide_test_doc = true
-hide_suite_doc = true
-hide_source = true
-hide_keywords = true
-style = "blue"
 verbose_mode = false
 
 [tool.testdoc.metadata]
 Author = "Your-Name"
 Version = "1.0.0"
 Source = "AnySourceAsMetaData"
-
-[tool.testdoc.colors]
-# Use predefined theme:
-default = "blue"
-# OR
-# Use custom 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"
-code_area_background = "#303030"
-code_area_foreground = "#f1f1f1"
-```
-
-## 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 OR cli.   
-Therefore, please use the following syntax: for the toml file
-```toml
-[colors]
-# Use the default theme
-default = "default"
-default = 0
-# Use the dark theme
-default = "dark"
-default = 1
-# Use the blue theme
-default = "blue"
-default = 2
-# Use the robot theme
-default = "robot"
-default = 3
-# Use the dark robot theme
-default = "robot_dark"
-default = 4
-# Use the green theme
-default = "green"
-default = 5
 ```
 
-For setting it via CLI, please use the following:
-```shell
-# Applying dark theme
-testdoc ... -S dark PATH OUTPUT_FILE
-
-# Applying blue theme
-testdoc ... --style blue PATH OUTPUT_FILE
-```
-
-> [!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"
-code_area_background = "#303030"
-code_area_foreground = "#f1f1f1"
-```
-
-> [!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!
-
-### Default Themes - Screenshot
-
-#### Dark
-
-![alt text](docs/style_dark.png)
-
-#### Blue
-
-![alt text](docs/style_blue.png)
-
-#### Robot / Default
-
-![alt text](docs/style_robot.png)
-
 ## Contribution & Development
 
 See [Development.md](./DEVELOPMENT.md) for more information about contributing & developing this library.

{robotframework_testdoc-0.5.0 → robotframework_testdoc-0.6.0}/pyproject.toml

@@ -95,13 +95,69 @@ dependencies = [
   "pytest"
 ]
 [tool.hatch.envs.dev.scripts]
-lint = "ruff check src/"
+lint = "ruff check --force-exclude"
+format = "ruff format --force-exclude"
 atest = "pytest atest/acceptance"
 perftest = "pytest atest/performance"
 alltest = "pytest atest"
 
+
 [tool.ruff]
 line-length = 150
-lint.select = ["E", "F"]  # Pyflakes & pycodestyle
-lint.ignore = ["E722"]
-exclude = ["build", "dist"]
+src = ["src"]
+exclude = [
+  ".venv",
+  ".git",
+  "__pycache__",
+  "build",
+  "dist",
+  "bootstrap.py",
+  "atest/",
+]
+
+[tool.ruff.lint]
+select = [
+  "E",
+  "F",
+  "W",
+  "C90",
+  "I",
+  "N",
+  "B",
+  "PYI",
+  "PL",
+  "PTH",
+  "UP",
+  "A",
+  "C4",
+  "DTZ",
+  "ISC",
+  "ICN",
+  "INP",
+  "PIE",
+  "T20",
+  "PYI",
+  "PT",
+  "RSE",
+  "RET",
+  "SIM",
+  "RUF"
+]
+ignore = [
+  "N999",  # Robot library names stay CamelCase
+]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.mypy]
+strict = true
+show_error_codes = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unreachable = true
+files = ["src"]
+exclude = "/(\\.venv|\\.git|__pycache__|build|dist|atest)/"
+disable_error_code = ["import-untyped"]