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.2.tar.gz
(129.4 kB
view details)
Built Distribution
rfdocserver-1.0.2-py3-none-any.whl
(132.5 kB
view details)
File details
Details for the file rfdocserver-1.0.2.tar.gz
.
File metadata
- Download URL: rfdocserver-1.0.2.tar.gz
- Upload date:
- Size: 129.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfc40878911119efc4cd4b48348c755ea4c9b13ccecf168ae63725c93ce3f794 |
|
MD5 | 868c294430bebea363d5411f4f51112f |
|
BLAKE2b-256 | 520d5a6725e468403e631a70e63dd821d3dda5fb71eaa8066f3dd51928fdeee4 |
File details
Details for the file rfdocserver-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: rfdocserver-1.0.2-py3-none-any.whl
- Upload date:
- Size: 132.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bdc288f3701f1d01260f3dd96072f15b8f886eb7a24005596e17ecab7266171 |
|
MD5 | 7a418b6f8c13c97199534c6b6e8e5ca9 |
|
BLAKE2b-256 | 62096dd11d52f3c40e36d64719131609b8046e607f42f2e93cfc85ffb02485c9 |