lookbook-hq / lookbook

A UI development environment for Ruby on Rails apps ✨

Home Page:https://lookbook.build

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

YARD generation

bjufre opened this issue · comments

Describe the bug

Hello! I'm trying to build a custom Rails documentation site for our internal DS and for that I'm using the trick of creating a custom reloader with some automatic generation with Yard that goes through all of the components and creates a cache with all the information needed to render the docs page for said component (with embeds for the examples) that we then render from the controller based on the "slug" of the component in the URL.

The generation seems to work somewhat except for:

  • When I try and read the fields for the yardoc generated in the registry, turns out that most of the filds (the params) for example are in fact Lookbook::ParamTag which for us that's not useful. How can I make sure that Lookbook doesn't interfere with the process in this case?

Thank you very muuuch!