Search code examples
rubyrubygemsrdoc

How do I add documentation to my gem that will show up on rubygems.org?


Experimenting with pushing my first gem to rubygems.org, and I'm trying to figure out how to generate online documentation for it. For most gems 'show' page, when I click the 'Documentation' link, I am brought to http://rubydoc.info/gems/gemname/version/frames. Is this something that will happen automagically if I generate the docs in the right place? Do I have to specify something in the gemspec? Thanks!


Solution

  • Here is the response that I received from someone in the RubyDoc community:

    Hi there,

    New gems can take up to a day to make it into RubyGems' master gem list. Not much we can do about this one. From then on, it's about an hour for new versions of your gem to be populated into the list (we run a cron job at *:15 to update our copy).

    It was a matter of letting enough time elapse.