Custom YARD handler is not applied

's Avatar

p0deje

27 May, 2013 02:35 AM

Hi,

I contact you about http://rubydoc.info/gems/watir-webdriver gem documentation. We're using a bit of metaprogramming to dynamically define methods for elements and use custom YARD handler to make sure they are documented.

It works perfectly locally or on self-hosted documentation (e.g. see "Instance Method Summary" on http://watir.github.io/watir-webdriver/doc/Watir/TextArea.html), but it doesn't work on Rubydoc.info (compare to http://rubydoc.info/gems/watir-webdriver/Watir/TextArea).

We have set up https://github.com/watir/watir-webdriver/blob/master/.yardopts to make sure handler is always used, but no luck.

Please, let me know if this can be achieved.

Thanks!

  1. Support Staff 1 Posted by lsegal on 27 May, 2013 02:42 AM

    lsegal's Avatar

    Unfortunately we disable plugins on rubydoc.info for security reasons. If you want custom code to be executed you'll have to package it up as a YARD plugin so that we can explicitly gem install it on the server (after reviewing the code).

    You can also take a look at seeing if macros can solve your problems so that you don't have to resort to custom handlers.

    Hope that helps!

  2. 2 Posted by p0deje on 27 May, 2013 02:57 AM

    p0deje's Avatar

    Thanks for quick reply, I'll try to use macros!

  3. lsegal closed this discussion on 28 Jul, 2013 05:25 PM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac