Documentation view - Link to own library section missing
Opened this issue · 2 comments
When documentation of a Keyword contains a link to the library introduction section no link is created.
Example:
Open the Library "DateTime" -> "Keyword Add Time To Date" documentation view;
• Missing link: date formats
.
• Missing link: time formats
.
• Missing link: millisecond handling
.
• Missing link: custom timestamp
Screenshot (Python 3.7.9, Robot Framework 3.2.2, RED 0.9.5)
Note: possible related with #398
Hi,
both #398 and #399 are caused by the same issue. The documentation view could be implemented in two ways generally:
- generate an html documentation for whole library and then post process it to cut it into slices and display proper slice for chosen keyword or general lib documenation for the library itself
- take the documentation of keyword and generate the docu only for it
Second apporach is used but this has a problem because robot tools for docu generation changes words in backticks into the proper hyperlinks to different document paragraphs. However if no such paragraph exists then no hyperlink is created and this issue is visible here: RED passes the fragment of documentation (the one for keyword Add Time To Date
) and in this fragment we are having linking to paragraphs outside of it and since it operates on fragment only no hyperlink is generated.
We would need to switch it to first approach althogh I'm not sure now if it has other drawbacks or not. This requires checking.
Also it is always possible to open the whole library documentation in html file (with the Open attached documentation in a browser
button)
Since I replied in this ticket I will close the first one as duplicate, although technically this one should be closed