Skip to content

docs: include Python library keywords in generated libdoc output - #1264

Open
KingParmenides wants to merge 1 commit into
Dasharo:mainfrom
KingParmenides:include-python-keywords-in-docs
Open

KingParmenides wants to merge 1 commit into
Dasharo:mainfrom
KingParmenides:include-python-keywords-in-docs

Conversation

@KingParmenides

Copy link
Copy Markdown

Summary

  • collect Python keyword libraries from lib/**/*.py while building the combined libdoc resource
  • read @keyword decorators with Python AST so docs generation does not need to import Python libraries or satisfy constructor arguments
  • emit keyword documentation and arguments into the generated resource alongside existing .robot keywords

Fixes #602

Verification

  • python3 scripts/create-docs.py /private/tmp/all-keywords-with-py.robot
  • /private/tmp/osfv-docs-venv/bin/libdoc /private/tmp/all-keywords-with-py.robot /private/tmp/all-keywords-with-py.html
  • confirmed generated resource contains menus.Check if menu line is an option, QemuMonitor.Add HDD To Qemu, and fan_curve_tests.Plot Fan Curve
  • /private/tmp/osfv-docs-venv/bin/black --check scripts/create-docs.py
  • /private/tmp/osfv-docs-venv/bin/isort --check-only scripts/create-docs.py
  • PYTHONPYCACHEPREFIX=/private/tmp/python-cache-osfv python3 -m py_compile scripts/create-docs.py
  • git diff --check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Keyword documentation generation doesn't include "*.py" files

1 participant