tag:help.rubygems.org,2010-01-19:/discussions/problems/34336-documentation-not-being-generated-as-intendedRubyGems.org: Discussion 2018-12-08T18:37:04Ztag:help.rubygems.org,2010-01-19:Comment/465259242018-11-20T14:59:29Z2018-11-20T14:59:30ZDocumentation not being generated as intended<div><p>I'm pushing my first gem, <a href="https://rubygems.org/gems/clonk">Clonk</a>, to RubyGems. I've encountered issues generating documentation that may be due to the structure of the gem. Classes in <code>lib/clonk</code> are required by the top-level module Clonk in <code>lib/clonk.rb</code>.</p>
<ul>
<li>When pushing without any documentation configured, the top-level module in <code>lib/clonk.rb</code> is documented.</li>
<li>The same occurs even after documenting classes in <code>lib/clonk</code>.</li>
<li>When running <code>yard</code> locally, the classes in <code>lib/clonk</code> are also documented. This is the desired outcome.</li>
</ul>
<p>How can I ensure that the classes in <code>lib/clonk</code> are also in the documentation generated on RubyGems?</p></div>Simon Fishtag:help.rubygems.org,2010-01-19:Comment/465259242018-12-08T18:37:02Z2018-12-08T18:37:02ZDocumentation not being generated as intended<div><p>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?</p>
<p><a href="https://github.com/docmeta/rubydoc.info">https://github.com/docmeta/rubydoc.info</a><br>
<a href="https://rubydoc.tenderapp.com/">https://rubydoc.tenderapp.com/</a></p>
<p>Hope this helps!</p></div>kerrizor