robotframework-testdoc 0.4.1__tar.gz → 0.4.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/PKG-INFO +12 -96
  2. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/README.md +11 -95
  3. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/.gitignore +0 -0
  4. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/LICENSE +0 -0
  5. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/pyproject.toml +0 -0
  6. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/default.toml +0 -0
  7. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/html/images/robotframework.svg +0 -0
  8. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/html/templates/mkdocs_default/overrides/partials/footer.html +0 -0
  9. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/html/templates/v1/jinja_template_01.html +0 -0
  10. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/html/templates/v1/jinja_template_02.html +0 -0
  11. {robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/src/testdoc/html/templates/v2/jinja_template_03.html +0 -0
{robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: robotframework-testdoc
3
- Version: 0.4.1
3
+ Version: 0.4.2
4
4
  Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
5
5
  Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
6
6
  Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
@@ -34,11 +34,17 @@ Requires-Dist: robotframework-robocop; extra == 'dev'
34
34
  Requires-Dist: ruff; extra == 'dev'
35
35
  Description-Content-Type: text/markdown
36
36
 
37
- # Robot Framework TestDoc
37
+ # robotframework-testdoc
38
+
39
+ The new tool to generate test documentation pages for your Robot Framework project.
38
40
 
39
41
  ## GitHub Project
40
42
 
41
- Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
43
+ Visit the project at [GitHub - robotframework-testdoc](ttps://github.com/MarvKler/robotframework-testdoc)
44
+
45
+ ## Documentation
46
+
47
+ Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
42
48
 
43
49
  ## Statistics
44
50
 
@@ -55,9 +61,6 @@ Install the tool using the following command:
55
61
  pip install robotframework-testdoc
56
62
  ```
57
63
 
58
- > [!IMPORTANT]
59
- > Preconditions: Python & Pip Installation.
60
-
61
64
  ## Usage
62
65
 
63
66
  ### Basic Usage
@@ -73,7 +76,7 @@ testdoc [OPTIONS] suite_directory output.html
73
76
  ```
74
77
 
75
78
  > [!TIP]
76
- > **Included Help:** Please execute ``testdoc --help`` for further details about the commandline arguments or see the examples below.
79
+ > **Included Help:** Visit the [CLI Documentation](https://marvkler.github.io/robotframework-testdoc/cli/cli/) for further arguments & details.
77
80
 
78
81
  ### Plugin Usage
79
82
 
@@ -82,67 +85,11 @@ You have two option to use it this way:
82
85
  1. You can write your own HTML page as ``jinja2`` template, add this HTML template as CLI argument while generating the docs and you will get your own HTML style as documentation page.
83
86
  2. You can use the ``mkdocs`` integration to define your own mkdcs template as CLI argument and the testdoc tool will internally take care of the mkdocs page generation.
84
87
 
85
- For further details about the usage, please read the [plugin usage documentation](./PLUGIN_USAGE.md).
88
+ For further details about the usage, please read the [official documentation](https://marvkler.github.io/robotframework-testdoc/usage).
86
89
 
87
90
  ## Examples
88
91
 
89
- Below you can find some example of using the testdoc library.
90
-
91
- > [!TIP]
92
- > Of course, you can combine all of them!
93
-
94
- ```shell
95
- # Generating docu without option
96
- testdoc tests/ TestDocumentation.html
97
-
98
- # Generating docu with new title, new root suite name, new root suite documentation text & new metadata
99
- testdoc -t "Robot Framework Test Automation" -n "System Tests" -d "Root Suite Documentation" -m "Root Suite Metadata" tests/ TestDocumentation.html
100
-
101
- # Generating docu with source prefix to navigate directly to its gitlab file path
102
- testdoc -s "https://gitlab.com/myrepository" tests/ TestDocumentation.html
103
-
104
- # Generating docu only with specific mentioned tags to include & exclude
105
- testdoc -i ManagementUI -e LongTime tests/ TestDocumentation.html
106
-
107
- # Generating docu only with multiple specific mentioned tags to include
108
- testdoc -i ManagementUI -i MQTT tests/ TestDocumentation.html
109
-
110
- # Generating docu only with new metadata for root suite object
111
- testdoc -m Version=0.1.1-dev -m Tester=RobotExpert tests/ TestDocumentation.html
112
-
113
- # Generating docu - hide tags information
114
- testdoc --hide-tags tests/ TestDocumentation.html
115
-
116
- # Generating docu - hide test case documentation texts
117
- testdoc --hide-test-doc tests/ TestDocumentation.html
118
-
119
- # Generating docu - hide test suite documentation texts
120
- testdoc --hide-suite-doc tests/ TestDocumentation.html
121
-
122
- # Generating docu - hide source information
123
- testdoc --hide-source tests/ TestDocumentation.html
124
-
125
- # Generating docu - hide keyword information (keyword calls in tests)
126
- testdoc --hide-keywords tests/ TestDocumentation.html
127
- ```
128
-
129
- ## Visualization of Keywords
130
-
131
- Keywords are visualized in a specific design and to replicate the robot framework test case structure (model) as best as possible.
132
-
133
- ### User / Library Keywords called in a Test Case Body
134
-
135
- This view does actually replicate the robot framework suite file with the ``*** Test Cases ***`` section, the ``Test Case Name`` and the ``Test Case Body``.
136
-
137
- ![alt text](docs/test_keywords_visualization.png)
138
-
139
- ### User Keyword defined in a Test Suite
140
-
141
- ![alt text](docs/suite_keywords_visualization.png)
142
-
143
- ## Robot Framework Tags
144
- The commandline arguments ``include`` & ``exclude`` have more or less the same functionality like in the known ``robot ...`` command.
145
- You can decide to weither include and / or exclude specific test cases into the test documentation.
92
+ Visit the official documentation to find some [Examples](https://marvkler.github.io/robotframework-testdoc/usage/#examples).
146
93
 
147
94
  ## External Configuration File
148
95
  The idea of the external configuration file is, having a central place for passing the known CMD arguments via file instead of CMD parameters.
@@ -201,37 +148,6 @@ code_area_background = "#303030"
201
148
  code_area_foreground = "#f1f1f1"
202
149
  ```
203
150
 
204
- ## HTML Template Selection
205
-
206
- You can choose between multiple HTML template for the design of your test documentation.
207
- These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
208
-
209
- ### Default Design
210
-
211
- - v2
212
-
213
- ### Available HTML Templates - NOT RECOMMENDED
214
-
215
- You can choose one of the following designs:
216
- - v1
217
- - v2
218
-
219
- ### Version 1
220
-
221
- #### Visit Tests
222
-
223
- ![alt text](docs/html_v1_common.png)
224
-
225
- ### Version 2
226
-
227
- #### Visit Tests on Root Suite Level
228
-
229
- ![alt text](docs/html_v2_root.png)
230
-
231
- #### Visit Tests on Suite File Level
232
-
233
- ![alt text](docs/html_v2_suitefile.png)
234
-
235
151
  ## Theme Selection / Color Configuration
236
152
 
237
153
  You can select between several themes (color configurations) for your HTML document to create!
{robotframework_testdoc-0.4.1 → robotframework_testdoc-0.4.2}/README.md RENAMED
@@ -1,8 +1,14 @@
1
- # Robot Framework TestDoc
1
+ # robotframework-testdoc
2
+
3
+ The new tool to generate test documentation pages for your Robot Framework project.
2
4
 
3
5
  ## GitHub Project
4
6
 
5
- Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
7
+ Visit the project at [GitHub - robotframework-testdoc](ttps://github.com/MarvKler/robotframework-testdoc)
8
+
9
+ ## Documentation
10
+
11
+ Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
6
12
 
7
13
  ## Statistics
8
14
 
@@ -19,9 +25,6 @@ Install the tool using the following command:
19
25
  pip install robotframework-testdoc
20
26
  ```
21
27
 
22
- > [!IMPORTANT]
23
- > Preconditions: Python & Pip Installation.
24
-
25
28
  ## Usage
26
29
 
27
30
  ### Basic Usage
@@ -37,7 +40,7 @@ testdoc [OPTIONS] suite_directory output.html
37
40
  ```
38
41
 
39
42
  > [!TIP]
40
- > **Included Help:** Please execute ``testdoc --help`` for further details about the commandline arguments or see the examples below.
43
+ > **Included Help:** Visit the [CLI Documentation](https://marvkler.github.io/robotframework-testdoc/cli/cli/) for further arguments & details.
41
44
 
42
45
  ### Plugin Usage
43
46
 
@@ -46,67 +49,11 @@ You have two option to use it this way:
46
49
  1. You can write your own HTML page as ``jinja2`` template, add this HTML template as CLI argument while generating the docs and you will get your own HTML style as documentation page.
47
50
  2. You can use the ``mkdocs`` integration to define your own mkdcs template as CLI argument and the testdoc tool will internally take care of the mkdocs page generation.
48
51
 
49
- For further details about the usage, please read the [plugin usage documentation](./PLUGIN_USAGE.md).
52
+ For further details about the usage, please read the [official documentation](https://marvkler.github.io/robotframework-testdoc/usage).
50
53
 
51
54
  ## Examples
52
55
 
53
- Below you can find some example of using the testdoc library.
54
-
55
- > [!TIP]
56
- > Of course, you can combine all of them!
57
-
58
- ```shell
59
- # Generating docu without option
60
- testdoc tests/ TestDocumentation.html
61
-
62
- # Generating docu with new title, new root suite name, new root suite documentation text & new metadata
63
- testdoc -t "Robot Framework Test Automation" -n "System Tests" -d "Root Suite Documentation" -m "Root Suite Metadata" tests/ TestDocumentation.html
64
-
65
- # Generating docu with source prefix to navigate directly to its gitlab file path
66
- testdoc -s "https://gitlab.com/myrepository" tests/ TestDocumentation.html
67
-
68
- # Generating docu only with specific mentioned tags to include & exclude
69
- testdoc -i ManagementUI -e LongTime tests/ TestDocumentation.html
70
-
71
- # Generating docu only with multiple specific mentioned tags to include
72
- testdoc -i ManagementUI -i MQTT tests/ TestDocumentation.html
73
-
74
- # Generating docu only with new metadata for root suite object
75
- testdoc -m Version=0.1.1-dev -m Tester=RobotExpert tests/ TestDocumentation.html
76
-
77
- # Generating docu - hide tags information
78
- testdoc --hide-tags tests/ TestDocumentation.html
79
-
80
- # Generating docu - hide test case documentation texts
81
- testdoc --hide-test-doc tests/ TestDocumentation.html
82
-
83
- # Generating docu - hide test suite documentation texts
84
- testdoc --hide-suite-doc tests/ TestDocumentation.html
85
-
86
- # Generating docu - hide source information
87
- testdoc --hide-source tests/ TestDocumentation.html
88
-
89
- # Generating docu - hide keyword information (keyword calls in tests)
90
- testdoc --hide-keywords tests/ TestDocumentation.html
91
- ```
92
-
93
- ## Visualization of Keywords
94
-
95
- Keywords are visualized in a specific design and to replicate the robot framework test case structure (model) as best as possible.
96
-
97
- ### User / Library Keywords called in a Test Case Body
98
-
99
- This view does actually replicate the robot framework suite file with the ``*** Test Cases ***`` section, the ``Test Case Name`` and the ``Test Case Body``.
100
-
101
- ![alt text](docs/test_keywords_visualization.png)
102
-
103
- ### User Keyword defined in a Test Suite
104
-
105
- ![alt text](docs/suite_keywords_visualization.png)
106
-
107
- ## Robot Framework Tags
108
- The commandline arguments ``include`` & ``exclude`` have more or less the same functionality like in the known ``robot ...`` command.
109
- You can decide to weither include and / or exclude specific test cases into the test documentation.
56
+ Visit the official documentation to find some [Examples](https://marvkler.github.io/robotframework-testdoc/usage/#examples).
110
57
 
111
58
  ## External Configuration File
112
59
  The idea of the external configuration file is, having a central place for passing the known CMD arguments via file instead of CMD parameters.
@@ -165,37 +112,6 @@ code_area_background = "#303030"
165
112
  code_area_foreground = "#f1f1f1"
166
113
  ```
167
114
 
168
- ## HTML Template Selection
169
-
170
- You can choose between multiple HTML template for the design of your test documentation.
171
- These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
172
-
173
- ### Default Design
174
-
175
- - v2
176
-
177
- ### Available HTML Templates - NOT RECOMMENDED
178
-
179
- You can choose one of the following designs:
180
- - v1
181
- - v2
182
-
183
- ### Version 1
184
-
185
- #### Visit Tests
186
-
187
- ![alt text](docs/html_v1_common.png)
188
-
189
- ### Version 2
190
-
191
- #### Visit Tests on Root Suite Level
192
-
193
- ![alt text](docs/html_v2_root.png)
194
-
195
- #### Visit Tests on Suite File Level
196
-
197
- ![alt text](docs/html_v2_suitefile.png)
198
-
199
115
  ## Theme Selection / Color Configuration
200
116
 
201
117
  You can select between several themes (color configurations) for your HTML document to create!