Skip to content

Welcome to robotframework-testdoc

Release Pipeline PyPI - Version PyPI - Python Version PyPI Downloads - Total PyPI Downloads - Monthly

This site provides details about robotframework-testdoc - the new tool for generating test documentations for your Robot Framework project. It supports modern tools like jinja2 & mkdocs to design good readable & good looking webpages!

Installation

Use the following command to install the tool: 

pip install robotframework-testdoc

⭐ Key Features

  • Displays amount of test cases in all (sub-)suite directories / suite files
  • Visualization of Keyword & Test Case Bodys in Robot Framework Suite File Syntax
  • Attach the Source Code Link of the current file to the Test Suite / Test Case Documentation - navigate directly to the file in GitLab, GitHub, etc...
  • Mkdocs & Jinja2 Compatible - create your own templates || use predefined templates provided by this tool

GitHub Project

Here you can find the GitHub Repository: robotframework-testdoc

Contribution / Raise Issue

Feel free to create an issue in case something is missing or you've found a bug: Create an Issue

Contribute!

Every contribution helps in improving the tool!

PyPi Project

Here you can find the PyPi Repository: robotframework-testdoc@PyPi