Libdoc's DocumentationBuilder
doesn't anymore work with resource files with .robot
extension
#4519
Labels
Milestone
When support for generating documentation for suite files was added (#4493), the
DocumentationBuilder
factory method was changed so that it returns aSuiteDocBuilder
with all files having a.robot
extension. This builder only works with suite files and not with resource files. TheLibraryDocumentation
factory method that usesDocumentationBuilder
handles this problem internally similarly as it handlesDocumentationBuilder
not supporting resource files in PYTHONPATH so this doesn't affect Libdoc itself. It does, however, affect direct usage ofDocumentationBuilder
.Changes like this are always annoying, but in this case this isn't too severe because
DocumentationBuilder
isn't really part of the public API andLibraryDocumentation
should be used instead of it. Alternatively, it's possible to useResourceDocBuilder
explicitly when working with resource files. The initial plan was to just document this behavior (#4517), but it is actually easy to fix this by makingDocumentationBuilder
a class instead of a factory method.A related problem is that Libdoc's public API isn't properly defined. A separate issue needs to be submitted about that. We can then explicitly recommend
LibraryDocumentation
.The text was updated successfully, but these errors were encountered: