Skip to main content

Web server for hosting robot framework documentation

Project description

rfdocserver

This python modules goal is to make browsing robot framework keyword documentation easier by generating browseable documentation with robot framework libdoc and host it with flask web server.

Installation

You can install this package with pip:

pip3 install rfdocserver

Running

This project should be run as python3 module.

python3 -m rfdocserver --robot_files <path to robot file root>

Features

  • Robot framework keyword documentation generation
  • Displaying documentation on web server
  • Keyword search
  • Input files can be python modules or path to them
    • Will recursively find files suitable for document creation if path is given
  • Can detect changes and regenerate documentation for files which are included via path
    • No need to reload this program to apply changes to your documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rfdocserver-1.0.1.tar.gz (116.8 kB view hashes)

Uploaded Source

Built Distribution

rfdocserver-1.0.1-py3-none-any.whl (132.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page