robotframework-testdoc 0.6.4__tar.gz → 0.8.0__tar.gz

{robotframework_testdoc-0.6.4 → robotframework_testdoc-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.6.4
+Version: 0.8.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
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
 Requires-Dist: click
+Requires-Dist: fpdf2
 Requires-Dist: jinja2
 Requires-Dist: mkdocs-include-markdown-plugin
 Requires-Dist: mkdocs-macros-plugin
@@ -50,13 +51,13 @@ Visit the official documentation for more details: [Documentation - robotframewo
 ## VS Code Extension
 
 Generate test documentation directly from the VS Code Explorer — no terminal required.  
-Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) and install it locally.
+Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases?q=VS+Code+Extension&expanded=true) and install it locally.
 
 ```bash
 code --install-extension testdoc-vscode-<version>.vsix
 ```
 
-See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension/) for details.
+See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension.html) for details.
 
 ## Statistics
 
@@ -102,9 +103,12 @@ testdoc tests/ TestDocumentation.html
 
 # JSON — machine-readable suite tree
 testdoc -f json tests/ TestDocumentation.json
+
+# PDF — release-ready export (overview + TOC + suites + test cases)
+testdoc -f pdf tests/ TestDocumentation.pdf
 ```
 
-Available values: `html` (default), `json`.
+Available values: `html` (default), `json`, `pdf`.
 
 ### Plugin Usage
 
@@ -115,6 +119,39 @@ 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).
 
+### Custom PDF Template
+
+You can provide your own Jinja2 template for PDF rendering:
+
+```shell
+testdoc -f pdf --custom-pdf-template path/to/pdf_template.html tests/ TestDocumentation.pdf
+```
+
+This works out of the box. No code changes are required.
+
+Required template contract:
+
+1. The template must contain a branch for `view == "overview"`.
+2. The template must contain a branch for `view == "suite"`.
+3. In the `overview` branch, these variables are available:
+	 `title` (string), `generated_at` (string), `suite_count` (int), `test_count` (int).
+4. In the `suite` branch, these variables are available:
+	 `suite_name` (string), `tests` (list of dicts).
+5. Each item in `tests` has:
+	 `name` (string), `tags` (list of strings, can be empty).
+
+Recommended usage pattern:
+
+1. Start with the minimal template above.
+2. Change only markup/styling first.
+3. Keep variable names exactly as documented.
+4. If a section is empty, always handle it with `{% if tests %}` / fallback text.
+
+Notes:
+
+1. Title page and table of contents are rendered by the PDF engine, not by the custom HTML template.
+2. You can also set `custom_pdf_template` in your TOML config file.
+
 #### Use customized Jinja2 HTML Template
 
 ![Custom Jinja Template](./docs/gifs/customjinja.gif)

{robotframework_testdoc-0.6.4 → robotframework_testdoc-0.8.0}/README.md

@@ -13,13 +13,13 @@ Visit the official documentation for more details: [Documentation - robotframewo
 ## VS Code Extension
 
 Generate test documentation directly from the VS Code Explorer — no terminal required.  
-Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) and install it locally.
+Download the latest `.vsix` from [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases?q=VS+Code+Extension&expanded=true) and install it locally.
 
 ```bash
 code --install-extension testdoc-vscode-<version>.vsix
 ```
 
-See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension/) for details.
+See the [VS Code Extension documentation](https://marvkler.github.io/robotframework-testdoc/usage/vscode-extension.html) for details.
 
 ## Statistics
 
@@ -65,9 +65,12 @@ testdoc tests/ TestDocumentation.html
 
 # JSON — machine-readable suite tree
 testdoc -f json tests/ TestDocumentation.json
+
+# PDF — release-ready export (overview + TOC + suites + test cases)
+testdoc -f pdf tests/ TestDocumentation.pdf
 ```
 
-Available values: `html` (default), `json`.
+Available values: `html` (default), `json`, `pdf`.
 
 ### Plugin Usage
 
@@ -78,6 +81,39 @@ 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).
 
+### Custom PDF Template
+
+You can provide your own Jinja2 template for PDF rendering:
+
+```shell
+testdoc -f pdf --custom-pdf-template path/to/pdf_template.html tests/ TestDocumentation.pdf
+```
+
+This works out of the box. No code changes are required.
+
+Required template contract:
+
+1. The template must contain a branch for `view == "overview"`.
+2. The template must contain a branch for `view == "suite"`.
+3. In the `overview` branch, these variables are available:
+	 `title` (string), `generated_at` (string), `suite_count` (int), `test_count` (int).
+4. In the `suite` branch, these variables are available:
+	 `suite_name` (string), `tests` (list of dicts).
+5. Each item in `tests` has:
+	 `name` (string), `tags` (list of strings, can be empty).
+
+Recommended usage pattern:
+
+1. Start with the minimal template above.
+2. Change only markup/styling first.
+3. Keep variable names exactly as documented.
+4. If a section is empty, always handle it with `{% if tests %}` / fallback text.
+
+Notes:
+
+1. Title page and table of contents are rendered by the PDF engine, not by the custom HTML template.
+2. You can also set `custom_pdf_template` in your TOML config file.
+
 #### Use customized Jinja2 HTML Template
 
 ![Custom Jinja Template](./docs/gifs/customjinja.gif)

{robotframework_testdoc-0.6.4 → robotframework_testdoc-0.8.0}/pyproject.toml

@@ -27,6 +27,7 @@ dependencies = [
     "click",
     "robotframework",
     "jinja2",
+  "fpdf2",
     "tomli",
     "mkdocs<2.0.0",
     "mkdocs-macros-plugin",

{robotframework_testdoc-0.6.4 → robotframework_testdoc-0.8.0}/src/testdoc/html/templates/jinja_html_default/jinja_template.html

@@ -330,38 +330,19 @@
                 {% endif %}
 
                 {% if s.tests %}
-                <!-- Test Case Overview -->
+                <!-- Test Cases -->
                 <section class="section">
                     <div class="section-header">
-                        <span class="section-title">Test Case Overview</span>
-                        <span class="section-subtitle">All {{ s.tests | length }} tests in this suite</span>
-                    </div>
-                    <div class="code-always-visible">
-                        {% set code -%}
-*** Test Cases ***
-{{ s.tests | map(attribute='name') | join('\n') }}
-                        {%- endset %}
-                        {{ code | highlight_robot_in_pre | safe }}
-                    </div>
-                </section>
-
-                <!-- Test Case Details -->
-                <section class="section">
-                    <div class="section-header">
-                        <span class="section-title">Test Case Details</span>
-                        <span class="section-subtitle">Per-test documentation and steps</span>
+                        <span class="section-title">Test Cases</span>
+                        <span class="section-subtitle">{{ s.tests | length }} test{% if s.tests | length != 1 %}s{% endif %} — click to view details</span>
                     </div>
                     <div class="tests-list">
                         {% for test in s.tests %}
                         {%- set _test_tags = [] -%}
                         {%- for _t in (test.tags or []) -%}{%- if _test_tags.append((_t.name if _t is mapping else _t) | string) -%}{%- endif -%}{%- endfor -%}
-                        <section id="test-{{ s.id }}-{{ loop.index0 }}" class="test-block collapsed" data-tags="{{ _test_tags | dump_json | e }}" data-has-doc="{{ '1' if test.doc else '0' }}" data-suite-name="{{ s.name }}" data-test-name="{{ test.name }}">
-                            <div class="test-header">
-                                <div class="test-name">{{ test.name }}</div>
-                                <span class="test-collapse-icon" aria-hidden="true">
-                                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"/></svg>
-                                </span>
-                            </div>
+
+                        {# Hidden data container used by showTestDetail #}
+                        <section id="test-{{ s.id }}-{{ loop.index0 }}" class="test-block" data-tags="{{ _test_tags | dump_json | e }}" data-has-doc="{{ '1' if test.doc else '0' }}" data-suite-name="{{ s.name }}" data-test-name="{{ test.name }}" data-suite-id="{{ s.id }}" hidden>
                             <div class="test-body-collapsible">
                                 <div class="test-subsection">
                                     <div class="kv-label">Documentation</div>
@@ -426,6 +407,26 @@
                                 </div>
                             </div>
                         </section>
+
+                        {# Visible clickable row #}
+                        <button class="test-list-row" data-target="test-{{ s.id }}-{{ loop.index0 }}" type="button">
+                            <span class="tree-icon test">T</span>
+                            <div class="test-list-main">
+                                <span class="test-list-name">{{ test.name }}</span>
+                                {% if test.doc %}
+                                <span class="test-list-doc">{{ test.doc | truncate(100) }}</span>
+                                {% endif %}
+                            </div>
+                            {% if _test_tags %}
+                            <div class="test-list-tags">
+                                {% for tag in _test_tags[:3] %}<span class="tag">{{ tag }}</span>{% endfor %}
+                                {% if _test_tags | length > 3 %}<span class="tag tag-more">+{{ _test_tags | length - 3 }} more</span>{% endif %}
+                            </div>
+                            {% endif %}
+                            <span class="test-list-chevron" aria-hidden="true">
+                                <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 18 15 12 9 6"/></svg>
+                            </span>
+                        </button>
                         {% endfor %}
                     </div>
                 </section>
@@ -485,6 +486,9 @@
         <!-- Statistics Dashboard (hidden by default, built by JS) -->
         <div id="dashboardPanel" class="dashboard-panel" style="display:none" role="region" aria-label="Statistics Dashboard"></div>
 
+        <!-- Test Case Detail View (single-page per test case) -->
+        <div id="testDetailPanel" class="test-detail-panel" style="display:none" role="region" aria-label="Test Case Detail"></div>
+
         <div id="suiteContent">
         {% if suites %}
             {{ render_suite_block(suites, 0) }}

robotframework_testdoc-0.8.0/src/testdoc/html/templates/jinja_pdf_default/pdf_template.html

@@ -0,0 +1,55 @@
+<html>
+  <body>
+    {% if view == "title" %}
+      <br /><br /><br /><br /><br />
+      <h1 align="center">{{ title }}</h1>
+      <p align="center">{{ generated_date }}</p>
+    {% elif view == "overview" %}
+      <h2 align="center">Overview</h2>
+
+      <table width="100%" border="1" cellspacing="0" cellpadding="7">
+        <tr>
+          <td bgcolor="#e2e8f0">Total .robot suites</td>
+          <td>{{ suite_count }}</td>
+        </tr>
+        <tr>
+          <td bgcolor="#e2e8f0">Total test cases</td>
+          <td>{{ test_count }}</td>
+        </tr>
+      </table>
+
+      <br />
+      <table width="100%" border="0" cellspacing="0" cellpadding="6">
+        <tr>
+          <td bgcolor="#eff6ff">Test Suites</td>
+        </tr>
+      </table>
+    {% else %}
+      <h1>{{ suite_name }}</h1>
+      <h3>Test Cases</h3>
+      {% if tests %}
+        <table width="100%" border="0" cellspacing="0" cellpadding="2">
+          {% for test in tests %}
+            {% if loop.first %}
+              <tr>
+                <td width="4%">-</td>
+                <td width="96%">{{ test.name }}</td>
+              </tr>
+            {% else %}
+              <tr>
+                <td>-</td>
+                <td>{{ test.name }}</td>
+              </tr>
+            {% endif %}
+          {% endfor %}
+        </table>
+      {% else %}
+        <table width="100%" border="0" cellspacing="0" cellpadding="6">
+          <tr>
+            <td bgcolor="#f1f5f9">No test cases in this suite.</td>
+          </tr>
+        </table>
+      {% endif %}
+    {% endif %}
+  </body>
+</html>

{robotframework_testdoc-0.6.4 → robotframework_testdoc-0.8.0}/vscode-extension/README.md

@@ -26,20 +26,57 @@ Download the latest `.vsix` file from the [GitHub Releases](https://github.com/M
 code --install-extension testdoc-vscode-<version>.vsix
 ```
 
+## Build VSIX Locally
+
+You can build the extension package (`.vsix`) on your machine.
+
+### Prerequisites
+
+- Node.js (LTS recommended)
+- npm
+
+### Steps
+
+1. Open a terminal in the extension folder:
+  ```bash
+  cd vscode-extension
+  ```
+2. Install dependencies:
+  ```bash
+  npm install
+  ```
+3. Build the `.vsix` package:
+  ```bash
+  npx @vscode/vsce package
+  ```
+4. The generated file will be in the same folder, for example:
+  ```
+  testdoc-vscode-0.1.7.vsix
+  ```
+
+### Install the locally built package
+
+```bash
+code --install-extension testdoc-vscode-<version>.vsix
+```
+
+If you want a new package version, update `version` in `vscode-extension/package.json` before running the package command.
+
 ## Usage
 
-Right-click any folder in the Explorer and choose one of the three commands:
+Right-click any folder in the Explorer and choose one of the available commands:
 
 | Command | Description |
 |---|---|
 | **testdoc: Generate HTML Documentation** | Generates a self-contained `.html` test documentation file |
 | **testdoc: Generate JSON Documentation** | Generates a machine-readable `.json` suite tree |
+| **testdoc: Generate PDF Documentation** | Generates a release-friendly `.pdf` report |
 | **testdoc: Generate MkDocs Output** | Generates a full MkDocs project into a selected output directory |
 
-### HTML / JSON
+### HTML / JSON / PDF
 
 1. Right-click a folder containing your `.robot` files
-2. Select **testdoc: Generate HTML Documentation** or **testdoc: Generate JSON Documentation**
+2. Select **testdoc: Generate HTML Documentation**, **testdoc: Generate JSON Documentation**, or **testdoc: Generate PDF Documentation**
 3. A save dialog opens — choose the output file location and name
 4. A terminal runs `testdoc` and the file is written to the chosen location