Home → Questions →

rubygems documentation

• Edit

hattwj

03 Nov, 2012 05:07 PM

I recently released my first gem on rubygems and the documentation isn't showing up. Am I doing something wrong, or is there an outage. My guess was that it was automatic when I uploaded the gem. Do I need to add a yard dependencie to my gem?

1. Support Staff 1 Posted by lsegal on 03 Nov, 2012 08:57 PM

   

   Which gem is this? You should not need yard as a dependency, but it could take a few hours for the first release of a new gem. Updated versions take up to 1hr.

   • Edit

2. 2 Posted by hattwj on 04 Nov, 2012 03:08 AM

   

   thank you for the reply. The name of the gem is Sshakery and I rake released it yesterday. If I am missing a step any help would be greatly appreciated.

   -wjh

   ----- Reply message -----
   From: "lsegal" <[email blocked]>
   To: <[email blocked]>
   Subject: rubygems documentation [Questions #16]
   Date: Sat, Nov 3, 2012 1:57 PM

   • Edit

3. 3 Posted by briandamaged on 04 Nov, 2012 05:51 PM

   

   Actually, I'm facing the same issue right now. I published my gem file about 12 hours ago, and the Documentation links are still dead. However, when I published the documentation via GitHub hooks, it appeared almost instantly.

   Gem: unobservable
   Rubygems URL: https://rubygems.org/gems/unobservable
   Rubydoc URL: http://rubydoc.info/gems/unobservable/0.1.1/frames

   • Edit

4. Support Staff 4 Posted by lsegal on 05 Nov, 2012 02:46 AM

   

   Both of these should work now. We're having issues with the server not properly reloading the app when pulling in new gems. Hopefully we can fix that soon.

   • Edit

5. lsegal closed this discussion on 05 Nov, 2012 02:46 AM.

6. Brian Lauber re-opened this discussion on 05 Nov, 2012 03:39 AM

7. 5 Posted by Brian Lauber on 05 Nov, 2012 03:39 AM

   

   Looks good now. Thanks!

   • Edit

8. 6 Posted by hattwj on 11 Nov, 2012 05:45 PM

   

   The documentation is available now, but my primary/largest class (AuthKeys) is missing in my gem documentation. I don't know if this is a related issue or if I should open up a separate help request.

   ----- Reply message -----
   From: "Brian Lauber" <[email blocked]>
   To: <[email blocked]>
   Subject: rubygems documentation [Questions #16]
   Date: Sun, Nov 4, 2012 7:39 PM

   • Edit

9. Support Staff 7 Posted by lsegal on 11 Nov, 2012 08:40 PM

   

   @hattwj, have you tried running YARD locally on your project? Does AuthKeys show up there?

   • Edit

10. 8 Posted by hattwj on 12 Nov, 2012 05:41 AM

    

    I just checked yard locally with the 0.0.4 gem and everything is there. The name of the missing class is AuthKeys.

    ----- Reply message -----
    From: "lsegal" <[email blocked]>
    To: <[email blocked]>
    Subject: rubygems documentation [Questions #16]
    Date: Sun, Nov 11, 2012 12:39 PM

    • Edit

11. Support Staff 9 Posted by lsegal on 12 Nov, 2012 05:45 AM

    

    I just checked the gem, running YARD locally does not work properly; there is actually a syntax error in the auth_keys.rb file:

    [warn]: Syntax error in `lib/sshakery/auth_keys.rb`:(439,30): syntax error, unexpected ':'
    

    Running the file through Ruby gives the same error:

    lib/sshakery/auth_keys.rb:439: syntax error, unexpected ':'
    lib/sshakery/auth_keys.rb:444: syntax error, unexpected ':'
    lib/sshakery/auth_keys.rb:449: syntax error, unexpected ':', expecting keyword_then or ';' or '\n'
    lib/sshakery/auth_keys.rb:453: syntax error, unexpected ':', expecting keyword_then or ';' or '\n'
    lib/sshakery/auth_keys.rb:455: syntax error, unexpected keyword_end, expecting $end
    

    It looks like your if statements around those lines are using the wrong syntax; that shouldn't actually parse.

    • Edit

12. 10 Posted by hattwj on 13 Nov, 2012 12:09 AM

    

    Thank you for the pointer. I released a new version, with that fixed. The odd thing is that it wasn't causing an error on my machine, but I'm running a slightly unusual setup (ruby 1.8.7 (2011-06-30 patchlevel 352) [arm-linux-eabi] ) on my phone.

    I did another rake release at 11am and now the documentation isn't showing up again (4pm).

    lsegal - thank you for all of the help.

    -wjh

    ----- Reply message -----
    From: "lsegal" <[email blocked]>
    To: <[email blocked]>
    Subject: rubygems documentation [Questions #16]
    Date: Sun, Nov 11, 2012 9:45 PM

    • Edit

13. Support Staff 11 Posted by lsegal on 25 Nov, 2012 10:01 PM

    

    Sorry, I lost track of this thread. Is everything working now, or are you still having issues?

    • Edit

14. 12 Posted by Brian Lauber on 26 Nov, 2012 05:02 AM

    

    Hi again.

    It appears that the original issue is resolved. However, I am still noticing some strangeness. After I upload a new version of the library, it takes several hours before the documentation catches up (it continues trying to generate documentation for the previous version). I can report this as a separate issue if it continues.

    Thanks!

           -=- Brian

    • Edit

15. Support Staff 13 Posted by lsegal on 26 Nov, 2012 05:13 AM

    

    This is normal. We update our gem index every hour, so a new version could take up to an hour to get sync'd on the site. Until then, only the previous docs will show up.

    • Edit

16. 14 Posted by hattwj on 26 Nov, 2012 05:04 PM

    

    I would like to add that everything is working for me! The only thing I have noticed is that when I was trying to get the documentation to work I published two versions of the gem on the same day (0.0.4 and 0.0.5 of Sshakery gem) and the 0.0.5 version is reported as being published a day after (Nov 10th I think) I actually published both of these on the same day (Nov 9th) around noon and about 40 minutes apart.

    Aside from that, everything is perfect.

    -wjh

    ________________________________
     From: lsegal <[email blocked]>
    To: [email blocked]
    Sent: Sunday, November 25, 2012 9:13 PM
    Subject: Re: rubygems documentation [Questions #16]

    • Edit

17. lsegal closed this discussion on 20 Mar, 2013 06:44 PM.