# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/bli74/robotframework-hub/",
"name": "robotframework-hub-static",
"maintainer": "Bert Lindemann",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Bert Lindemann <bert.lindemann@gmail.com>",
"keywords": "robotframework",
"author": "Bryan Oakley",
"author_email": "Bryan Oakley <bryan.oakley@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/11/09c5f17d0e00991f9b803bcde07f69795020532bc2959e271908caa09e43/robotframework_hub_static-1.0.3.tar.gz",
"platform": null,
"description": "# Welcome to Robot Framework Hub Static\n\n## Motivation\nThis project is based on Robot Framework Hub to generate\nkeyword documentation for a robotframework environment.\n\nThe original Robot Framework Hub needs a running web server\nprocess. There are no artifacts that can be published by a \nCI/CD pipeline.\n\nHere Robot Framework Hub Static can be used. It generates\nwith \u00b4libdoc\u00b4 the documentation for the robot internal \nlibraries, additional installed robot libraries and robot\nresource files.\nBased on the list of the generated HTML files an index page\nis created\n\n## Getting started\n\n```\n $ pip install robotframework-hub-static\n $ keyword_doc ${ROOT_PATH_ROBOT_RESOURCES} ${DOCU_DIR}\n```\n\nNote:\n* robotframework-hub requires python 3.6 or greater\n* The documentation directory is cleaned up, use a dedicated\n directory to store the documentation.\n\n\n## Websites\n\nSource code, screenshots, and additional documentation can be\nfound here:\n\n* Source code: https://github.com/bli74/robotframework-hub-static\n\nThis is a fork of the initial project:\n\n* Source code (updated): https://github.com/bli74/robotframework-hub\n* Source code (upstream): https://github.com/boakley/robotframework-hub\n* Project wiki: https://github.com/boakley/robotframework-hub/wiki\n\n## Acknowledgements\n\nA huge thank-you to Echo Global Logistics (echo.com) for supporting\nthe development of this package.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Create robot keyword documentation as static HTML",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/bli74/robotframework-hub-static",
"Issues": "https://github.com/bli74/robotframework-hub-static/issues",
"Repository": "https://github.com/bli74/robotframework-hub-static"
},
"split_keywords": [
"robotframework"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3f32a083af471e049ea8694d8031c0549300667cadbe917c6d764c227dfef35c",
"md5": "16607c3c91e689b8dd435adffecb20b8",
"sha256": "20b27c54aa82a104768c6a2fa0ed57330094cf7c4592346ce9c0bb638a7c02fe"
},
"downloads": -1,
"filename": "robotframework_hub_static-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16607c3c91e689b8dd435adffecb20b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 169051,
"upload_time": "2025-09-12T07:36:25",
"upload_time_iso_8601": "2025-09-12T07:36:25.781503Z",
"url": "https://files.pythonhosted.org/packages/3f/32/a083af471e049ea8694d8031c0549300667cadbe917c6d764c227dfef35c/robotframework_hub_static-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4a1109c5f17d0e00991f9b803bcde07f69795020532bc2959e271908caa09e43",
"md5": "29b8086342d07f6d6ecef3ae494b28f7",
"sha256": "98b311e4a6b8bee81a2530506e0191338ab2e36935bc2c6b94561e656fefd4a1"
},
"downloads": -1,
"filename": "robotframework_hub_static-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "29b8086342d07f6d6ecef3ae494b28f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 179329,
"upload_time": "2025-09-12T07:36:26",
"upload_time_iso_8601": "2025-09-12T07:36:26.771925Z",
"url": "https://files.pythonhosted.org/packages/4a/11/09c5f17d0e00991f9b803bcde07f69795020532bc2959e271908caa09e43/robotframework_hub_static-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-12 07:36:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bli74",
"github_project": "robotframework-hub",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Flask",
"specs": [
[
">=",
"1.1.1"
]
]
},
{
"name": "Jinja2",
"specs": [
[
">=",
"2.11.3"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
">=",
"0.23"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"5.4"
]
]
},
{
"name": "Werkzeug",
"specs": [
[
">=",
"0.15.3"
]
]
},
{
"name": "itsdangerous",
"specs": [
[
">=",
"0.24"
]
]
},
{
"name": "tornado",
"specs": [
[
">=",
"6.0.3"
]
]
},
{
"name": "pathtools3",
"specs": [
[
">=",
"0.2.1"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.20.0"
]
]
},
{
"name": "robotframework",
"specs": [
[
">=",
"2.8.5"
]
]
},
{
"name": "robotframework-requests",
"specs": [
[
">=",
"0.5.0"
]
]
},
{
"name": "robotframework-seleniumlibrary",
"specs": [
[
">=",
"4.0.0"
]
]
},
{
"name": "watchdog",
"specs": [
[
">=",
"0.9.0"
]
]
}
],
"lcname": "robotframework-hub-static"
}
JSON
