Welcome to Robot Framework Hub Static
Motivation
This project is based on Robot Framework Hub to generate keyword documentation for a robotframework environment.
The original Robot Framework Hub needs a running web server process. There are no artifacts that can be published by a CI/CD pipeline.
Here Robot Framework Hub Static can be used. It generates with ´libdoc´ the documentation for the robot internal libraries, additional installed robot libraries and robot resource files. Based on the list of the generated HTML files an index page is created
Getting started
$ pip install robotframework-hub-static
$ keyword_doc ${ROOT_PATH_ROBOT_RESOURCES} ${DOCU_DIR}
Note:
- robotframework-hub requires python 3.6 or greater
- The documentation directory is cleaned up, use a dedicated directory to store the documentation.
Websites
Source code, screenshots, and additional documentation can be found here:
- Source code: https://github.com/bli74/robotframework-hub-static
This is a fork of the initial project:
- Source code (updated): https://github.com/bli74/robotframework-hub
- Source code (upstream): https://github.com/boakley/robotframework-hub
- Project wiki: https://github.com/boakley/robotframework-hub/wiki
Acknowledgements
A huge thank-you to Echo Global Logistics (echo.com) for supporting the development of this package.
1 maintainer
Metadata
1 maintainer
Release files for robotframework-hub-static 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| robotframework_hub_static-1.0.3.tar.gz | 179.3 kB | Without provenance | Details for robotframework_hub_static-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| robotframework_hub_static-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for robotframework_hub_static-1.0.3-py3-none-any.whl |
Total release size: 348.4 kB
Release files / robotframework_hub_static-1.0.3.tar.gz
| Download URL | robotframework_hub_static-1.0.3.tar.gz |
|---|---|
| Size | 179.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98b311e4a6b8bee81a2530506e0191338ab2e36935bc2c6b94561e656fefd4a1
|
|
BLAKE2b-256 checksum How to use checksums |
4a1109c5f17d0e00991f9b803bcde07f69795020532bc2959e271908caa09e43
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.23
|
Release files / robotframework_hub_static-1.0.3-py3-none-any.whl
| Download URL | robotframework_hub_static-1.0.3-py3-none-any.whl |
|---|---|
| Size | 169.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20b27c54aa82a104768c6a2fa0ed57330094cf7c4592346ce9c0bb638a7c02fe
|
|
BLAKE2b-256 checksum How to use checksums |
3f32a083af471e049ea8694d8031c0549300667cadbe917c6d764c227dfef35c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.23
|
Security for robotframework-hub-static 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
