Ruby API Docs - Contributing

(@sam, ping for interest)

Currently, the information comes from meta tags in the page’s <head> section, not from the <body> content.

Keep in mind that YARD doc page’s is new to “Oneboxing”, (ie I had to add in into the template,) … so having “oneboxed” links to content paragraphs (method descriptions) is not something that was thought about much when the OneBox was invented.

You could perhaps customize the OneBox plugin that this forum uses, but other sites would still just “box” the class or module pages’s data.

The individual method text would need to be wrapped in some kind of HTML or XML tag so that the OneBox plugin could parse the text out of the page’s source.

To fix your URLs just insert a space at the beginning of the line, and the link will not be “oneboxed”.

1 Like