PyPI - robotframework-testdoc - Versions diffs - 0.6.1__tar.gz → 0.6.2__tar.gz - Mend

robotframework-testdoc 0.6.1tar.gz → 0.6.2tar.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 (9) hide show

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/.gitignore RENAMED Viewed

@@ -1,8 +1,6 @@
 __pycache__/**
 src/robotframework_testdoc.egg-info/**
 **/__pycache__/**.pyc
-.vscode/launch.json
-.vscode/
 dist/
 *.egg-info/
 output_doc.html
@@ -22,4 +20,6 @@ atest/mkdocs_test/**
 atest/mkdocs_test_perf/**
 atest/mkdocs_test_custom/**
 docs/mkdocs/site/**
-.DS_Store
+.DS_Store
+.vscode/mcp.json
+.vscode/settings.json

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.6.1
+Version: 0.6.2
 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
@@ -21,7 +21,6 @@ Requires-Dist: mkdocs-include-markdown-plugin
 Requires-Dist: mkdocs-macros-plugin
 Requires-Dist: mkdocs-material
 Requires-Dist: mkdocs<2.0.0
-Requires-Dist: pydantic
 Requires-Dist: pymdown-extensions
 Requires-Dist: robotframework
 Requires-Dist: tomli
@@ -32,6 +31,7 @@ Requires-Dist: pre-commit; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: rf-mcp; extra == 'dev'
 Requires-Dist: robotframework-robocop; extra == 'dev'
+Requires-Dist: robotframework-tablelibrary; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/pyproject.toml RENAMED Viewed

@@ -28,7 +28,6 @@ dependencies = [
     "robotframework",
     "jinja2",
     "tomli",
-    "pydantic",
     "mkdocs<2.0.0",
     "mkdocs-macros-plugin",
     "mkdocs-material",
@@ -44,6 +43,7 @@ dev = [
     "pre-commit",
     "mypy",
     "robotframework-robocop",
+    "robotframework-tablelibrary",
     "rf-mcp"
 ]

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/src/testdoc/html/templates/jinja_html_default/jinja_template.html RENAMED Viewed

@@ -13,6 +13,17 @@
 <body>
 {% set suite = suites if suites else None %}
+{# ------------------------------------------------------------
+   Template helpers
+   ------------------------------------------------------------ #}
+{% macro suite_icon(is_folder) -%}
+    {%- if is_folder -%}
+        <svg viewBox="0 0 24 24" aria-hidden="true"><path d="M3 7a2 2 0 0 1 2-2h5l2 2h7a2 2 0 0 1 2 2v9a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2V7z"/></svg>
+    {%- else -%}
+        <svg viewBox="0 0 24 24" aria-hidden="true"><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>
+    {%- endif -%}
+{%- endmacro %}
 <!-- ============================================================
      TOP HEADER BAR
      ============================================================ -->
@@ -76,11 +87,7 @@
                     <a href="#suite-{{ suite.id }}" class="tree-suite active"
                        data-target="suite-{{ suite.id }}" data-suite-id="{{ suite.id }}">
                         <span class="tree-icon {% if suite.is_folder %}suite-folder{% else %}suite-file{% endif %}">
-                            {% if suite.is_folder %}
-                                <svg viewBox="0 0 24 24" aria-hidden="true"><path d="M3 7a2 2 0 0 1 2-2h5l2 2h7a2 2 0 0 1 2 2v9a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2V7z"/></svg>
-                            {% else %}
-                                <svg role="img" viewBox="0 0 24 24" aria-hidden="true" xmlns="http://www.w3.org/2000/svg"><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>
-                            {% endif %}
+                            {{ suite_icon(suite.is_folder) }}
                         </span>
                         <span class="tree-main-label">{{ suite.name }}</span>
                     </a>
@@ -94,11 +101,7 @@
                                         <a href="#suite-{{ s.id }}" class="tree-suite"
                                            data-target="suite-{{ s.id }}" data-suite-id="{{ s.id }}">
                                             <span class="tree-icon {% if s.is_folder %}suite-folder{% else %}suite-file{% endif %}">
-                                                {% if s.is_folder %}
-                                                    <svg viewBox="0 0 24 24" aria-hidden="true"><path d="M3 7a2 2 0 0 1 2-2h5l2 2h7a2 2 0 0 1 2 2v9a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2V7z"/></svg>
-                                                {% else %}
-                                                    <svg role="img" viewBox="0 0 24 24" aria-hidden="true" xmlns="http://www.w3.org/2000/svg"><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>
-                                                {% endif %}
+                                                {{ suite_icon(s.is_folder) }}
                                             </span>
                                             <span class="tree-main-label">{{ s.name }}</span>
                                         </a>
@@ -130,6 +133,25 @@
     <!-- MAIN CONTENT -->
     <main class="content" id="mainContent">
+        {# ------------------------------------------------------------
+           PoC: Keyword documentation metadata
+           We keep the lexer + Pygments highlighting unchanged.
+           Instead, we embed resolved keyword docs (already available in the
+           parsed model) as NDJSON per test block. The frontend can then add
+           a small info button next to each keyword call line.
+           ------------------------------------------------------------ #}
+        {% macro emit_kw_doc_ndjson(items) %}
+            {% for item in (items or []) %}
+                {% if item.type == 'KEYWORD' and item.keyword_doc %}
+{{ {'name': item.name, 'owner': item.keyword_owner, 'doc': item.keyword_doc, 'args': item.args} | dump_json }}
+                {% endif %}
+                {% if item.body %}
+{{ emit_kw_doc_ndjson(item.body) }}
+                {% endif %}
+            {% endfor %}
+        {% endmacro %}
         {% macro render_suite_block(s, level) %}
         <section class="suite-block" data-suite-id="{{ s.id }}">
@@ -298,6 +320,15 @@
                                 <div class="test-subsection">
                                     <div class="kv-label">Body</div>
                                     {% if test.body or test.setup or test.teardown %}
+                                    <script type="application/x-ndjson" class="kw-doc-ndjson" data-test-target="test-{{ s.id }}-{{ loop.index0 }}">
+{% if test.setup and test.setup.keyword_doc %}
+{{ {'name': test.setup.name, 'owner': test.setup.keyword_owner, 'doc': test.setup.keyword_doc, 'args': test.setup.args, 'fixture': 'setup'} | dump_json }}
+{% endif %}
+{% if test.teardown and test.teardown.keyword_doc %}
+{{ {'name': test.teardown.name, 'owner': test.teardown.keyword_owner, 'doc': test.teardown.keyword_doc, 'args': test.teardown.args, 'fixture': 'teardown'} | dump_json }}
+{% endif %}
+{{ emit_kw_doc_ndjson(test.body) }}
+                                    </script>
                                     <div class="code-wrapper">
                                         <button class="code-toggle">
                                             <span>Show / Hide Code</span>
@@ -401,53 +432,5 @@
 </div>
 <script>{% include 'script.js' %}</script>
-<script>
-    // Theme toggle
-    (function () {
-        var btn = document.getElementById('themeToggle');
-        if (!btn) return;
-        btn.addEventListener('click', function () {
-            var html = document.documentElement;
-            var isDark = html.getAttribute('data-theme') === 'dark';
-            var next = isDark ? 'light' : 'dark';
-            html.setAttribute('data-theme', next);
-            try { localStorage.setItem('clarity-theme', next); } catch (e) {}
-        });
-    })();
-    // Sidebar toggle
-    (function () {
-        var btn = document.getElementById('sidebarToggle');
-        var sidebar = document.getElementById('sidebar');
-        var body = document.getElementById('appBody');
-        if (!btn || !sidebar) return;
-        btn.addEventListener('click', function () {
-            sidebar.classList.toggle('collapsed');
-            if (body) body.classList.toggle('sidebar-collapsed');
-        });
-    })();
-    // Sub-suite rows: delegate click to matching sidebar tree link
-    document.querySelectorAll('.subsuite-link').forEach(function (el) {
-        el.addEventListener('click', function (e) {
-            e.preventDefault();
-            var suiteId = this.dataset.suiteId;
-            var treeLink = document.querySelector('.tree-suite[data-suite-id="' + suiteId + '"]');
-            if (treeLink) treeLink.click();
-        });
-    });
-    // Test case collapse toggle
-    document.querySelectorAll('.test-header').forEach(function (header) {
-        header.addEventListener('click', function (e) {
-            e.stopPropagation();
-            var block = this.closest('.test-block');
-            if (!block) return;
-            var isCollapsed = block.classList.toggle('collapsed');
-            var body = block.querySelector('.test-body-collapsible');
-            if (body) body.style.display = isCollapsed ? 'none' : '';
-        });
-    });
-</script>
 </body>
 </html>

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/LICENSE RENAMED Viewed

File without changes

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/README.md RENAMED Viewed

File without changes

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/src/testdoc/default.toml RENAMED Viewed

File without changes

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/src/testdoc/html/images/robotframework.svg RENAMED Viewed

File without changes

{robotframework_testdoc-0.6.1 → robotframework_testdoc-0.6.2}/src/testdoc/html/templates/mkdocs_default/overrides/partials/footer.html RENAMED Viewed

File without changes

robotframework-testdoc 0.6.1__tar.gz → 0.6.2__tar.gz

robotframework-testdoc 0.6.1tar.gz → 0.6.2tar.gz