Metadata-Version: 2.1
Name: rfdocserver
Version: 1.0.2
Summary: Web server for hosting robot framework documentation
Home-page: https://github.com/juha-ylikoski/rfdocserver
Author: Juha Ylikoski
Author-email: juha.ylikoski14@outlook.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Framework :: Flask
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: robotframework (>=3.2)
Requires-Dist: beautifulsoup4 (>=4.9.1)
Requires-Dist: argparse (>=1.4.0)
Requires-Dist: Flask (>=1.1.2)
Requires-Dist: waitress (>=1.4.4)

# 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


