robotframework-testdoc 0.6.3a1__tar.gz → 0.6.3a2__tar.gz

{robotframework_testdoc-0.6.3a1 → robotframework_testdoc-0.6.3a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.6.3a1
+Version: 0.6.3a2
 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
@@ -47,6 +47,17 @@ Visit the project at [GitHub - robotframework-testdoc](https://github.com/MarvKl
 
 Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
 
+## 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.
+
+```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.
+
 ## Statistics
 
 [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  

{robotframework_testdoc-0.6.3a1 → robotframework_testdoc-0.6.3a2}/README.md

@@ -10,6 +10,17 @@ Visit the project at [GitHub - robotframework-testdoc](https://github.com/MarvKl
 
 Visit the official documentation for more details: [Documentation - robotframework-testdoc](https://marvkler.github.io/robotframework-testdoc/)
 
+## 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.
+
+```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.
+
 ## Statistics
 
 [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  

robotframework_testdoc-0.6.3a2/vscode-extension/README.md

@@ -0,0 +1,68 @@
+# testdoc – VS Code Extension
+
+Generate Robot Framework test documentation directly from the VS Code Explorer — no terminal required.
+
+## Requirements
+
+- **VS Code** `^1.85.0`
+- **Python extension** (`ms-python.python`) installed and configured
+- **robotframework-testdoc** installed in your active Python environment:
+  ```bash
+  pip install robotframework-testdoc
+  ```
+
+## Installation
+
+This extension is not published on the VS Code Marketplace.  
+Download the latest `.vsix` file from the [GitHub Releases](https://github.com/MarvKler/robotframework-testdoc/releases) page and install it locally.
+
+**Option A – VS Code UI:**
+1. Open the Extensions view (`Ctrl+Shift+X` / `Cmd+Shift+X`)
+2. Click the `...` menu → **Install from VSIX...**
+3. Select the downloaded `.vsix` file
+
+**Option B – Terminal:**
+```bash
+code --install-extension testdoc-vscode-<version>.vsix
+```
+
+## Usage
+
+Right-click any folder in the Explorer and choose one of the three 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 MkDocs Output** | Generates a full MkDocs project into a selected output directory |
+
+### HTML / JSON
+
+1. Right-click a folder containing your `.robot` files
+2. Select **testdoc: Generate HTML Documentation** or **testdoc: Generate JSON 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
+
+### MkDocs
+
+1. Right-click a folder containing your `.robot` files
+2. Select **testdoc: Generate MkDocs Output**
+3. A folder picker opens — select an **empty or new** output directory
+4. A terminal runs `testdoc --mkdocs` and the MkDocs project is written to the selected directory
+
+> The extension automatically uses the Python interpreter configured for the workspace via the **Python extension**.  
+> Make sure `robotframework-testdoc` is installed in that interpreter.
+
+## Troubleshooting
+
+**`python: command not found` / `testdoc: No module named testdoc`**  
+→ Select the correct Python interpreter via `Ctrl+Shift+P` → **Python: Select Interpreter** and ensure `robotframework-testdoc` is installed there.
+
+**The context menu commands do not appear**  
+→ Right-click must be on a **folder**, not a file.
+
+## Related Links
+
+- [robotframework-testdoc on PyPI](https://pypi.org/project/robotframework-testdoc)
+- [Official Documentation](https://marvkler.github.io/robotframework-testdoc/)
+- [GitHub Repository](https://github.com/MarvKler/robotframework-testdoc)