Libdoc: Support generating keyword documentation for suite files

[d-biehl]

When I want to create a library documentation for files that contains keywords and test cases, I get an error message:

❯ libdoc .\suite.robot suite.html
Error in file 'suite.robot' on line 1: Resource file with 'Test Cases' section is invalid.

Try --help for usage information.

I think it should also be possible to create a library documentation for such files.

• simply for the documentation of the keywords contained there
• in RobotCode there is a function that allows to display the library documentation in VSCode. On the one hand you can easily show the full documentation, on the other hand it is a good help to write the documentation, because you have a preview of what you have written.

This documentation is generated on the fly and displayed in the VSCode window. This works for libraries and resource files, but not for suite files.

I have already started to make a PR #4492, but I don't get to finish it yet, (holiday today, new heating system tomorrow, Wednesday RoboCon, ...).

can you check the PR and I think at the end of the week I can add/correct the test cases.

[pekkaklarck]

Sounds reasonable and especially showing this information in IDEs is important. I ought to have time to implement this myself on Tuesday.

[pekkaklarck]

This enhancement will require rc 2 and will belay the final release a bit. We already discussed on Slack that it is ok.

[pekkaklarck]

Implemented in the above commit. Still need to check how __init__.robot files are handled and update the User Guide. Cannot continue with them right now, but I hopefully get back to this still today.

[pekkaklarck]

Ought to be done now. Please give the new functionality a spin @d-biehl!

[d-biehl]

It works. But do not have time to test it fully. After RoboCon I will have it.

[pekkaklarck]

This change was backwards compatible because Libdoc's DocumentationBuilder factory method behavior changed so that if you use it with a file having .robot extension it returns a SuiteDocBuilder instead of a ResourceDocBuilder. Using a SuiteDocBuilder then won't work if the file doesn't contain tests.

I'll submit a separate issue about handling this problem in RF 6.0.1. My current thinking is that we only need to update documentation of the factory method and instruct users to use ResourceDocBuilder explicitly if needed.