Documentation not being generated as intended

Simon Fish's Avatar

Simon Fish

20 Nov, 2018 02:59 PM

I'm pushing my first gem, Clonk, to RubyGems. I've encountered issues generating documentation that may be due to the structure of the gem. Classes in lib/clonk are required by the top-level module Clonk in lib/clonk.rb.

  • When pushing without any documentation configured, the top-level module in lib/clonk.rb is documented.
  • The same occurs even after documenting classes in lib/clonk.
  • When running yard locally, the classes in lib/clonk are also documented. This is the desired outcome.

How can I ensure that the classes in lib/clonk are also in the documentation generated on RubyGems?

  1. Support Staff 1 Posted by kerrizor on 08 Dec, 2018 06:37 PM

    kerrizor's Avatar

    Thanks for writing in. Unfortunately, we're not generating the documentation found at Rubydocs.info; perhaps they'd be able to help sort it out for you?

    https://github.com/docmeta/rubydoc.info
    https://rubydoc.tenderapp.com/

    Hope this helps!

  2. kerrizor closed this discussion on 08 Dec, 2018 06:37 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