Skip to content

Include Python libraries in keyword docs - #1266

Open
suhail-ak-2 wants to merge 1 commit into
Dasharo:mainfrom
suhail-ak-2:bounty-602-python-libdoc-keywords
Open

Include Python libraries in keyword docs#1266
suhail-ak-2 wants to merge 1 commit into
Dasharo:mainfrom
suhail-ak-2:bounty-602-python-libdoc-keywords

Conversation

@suhail-ak-2

Copy link
Copy Markdown

Summary

  • generate Libdoc JSON for the existing combined Robot keyword file
  • generate Libdoc JSON for Python keyword libraries under lib/**/*.py and merge their keywords into the combined docs
  • handle lib/QemuMonitor.py with a temporary placeholder constructor argument
  • update README docs-generation wording

Fixes #602

Verification

  • PATH=/tmp/osfv-libdoc-venv/bin:$PATH ./scripts/create-docs.sh
  • grep -o 'menus\\.Check if menu line is an option\\|QemuMonitor\\.Add HDD To Qemu\\|fan_curve_tests\\.Plot Fan Curve' docs/index.html | sort | uniq -c\n- bash -n scripts/create-docs.sh\n- python3 -m py_compile scripts/merge-libdoc-json.py\n- git diff --check\n\nAI-assisted with OpenAI Codex.

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