manykarim / robotframework-doctestlibrary

Robot Framework DocTest library. Simple Automated Visual Document Testing.
Apache License 2.0
48 stars 21 forks source link

Keyword Documentation #22

Closed csello-landsure closed 2 years ago

csello-landsure commented 2 years ago

Hi,

After seeing the Project's video presentation from RoboCon 2021, I was interested in making use of this library for some of my organizations testing workflows. The video presentation is very useful for understanding the library, and how to use it. However, I was also hoping to be able to make use of textual keyword documentation before making use of the library in earnest.

When I look at the keyword documentation, I just see raw HTML code instead of the documentation. Am I doing something wrong?

image image

manykarim commented 2 years ago

Hi,

At the moment we need to use https://htmlpreview.github.io/ as a workaround. You need to copy URL of the keyword documentation files and open them from that page https://htmlpreview.github.io/ . The alternative is to download the raw html files from GitHub and open them afterwards in your local browser. Hope that helps.

BR, Many

csello-landsure @.***> schrieb am Do., 14. Okt. 2021, 00:16:

Hi,

After seeing the Project's video presentation from RoboCon 2021, I was interested in making use of this library for some of my organizations testing workflows. The video presentation is very useful for understanding the library, and how to use it. However, I was also hoping to be able to make use of textual keyword documentation before making use of the library in earnest.

When I look at the keyword documentation, I just see raw HTML code instead of the documentation. Am I doing something wrong?

[image: image] https://user-images.githubusercontent.com/92488127/137219920-e8a16f74-af05-4223-b778-a8988c190be2.png [image: image] https://user-images.githubusercontent.com/92488127/137219991-d1d140c2-50d4-4d0e-9319-fe59ca4b6862.png

  • Clint

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/manykarim/robotframework-doctestlibrary/issues/22, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOTUE3C76TCR53VL5HOM7TDUGYALBANCNFSM5F6HSNRA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

csello-landsure commented 2 years ago

Thank you, Many. On that basis I'll close-out this issue.