docmeta / rubydoc.info Goto Github PK

We're only supporting GitHub repos for now.

Some methods (e.g. Kernel#sprintf) aren't documented. The description text is missing.

Used to be that you could type http://rubydoc.info/gems/rspec-core in a browser and get redirected to something useful (I think it was http://rubydoc.info/gems/rspec-core/frames), but now you just get a blank page.

Forks should be listed below each project name with the master fork shown first.

I went to http://rubydoc.info/find/github?q=rspec-expectations, clicked the refresh icon, landed on http://rubydoc.info/github/rspec/rspec-expectations/master/frames, but what I see there is not what is in the current master branch.

I just pushed a release of rspec and I've got a blog post sitting and waiting for my shiny new rdoc to appear on rubydoc.info :) Besides nudging somebody to perform some behind the scenes magic, it would be great if there was a hook I could use to nudge rubydoc.info directly so it knows to generate the docs for the latest release right away.

In the mean time ... nudge :)

I've got a persistent error on my Alf github project.

git://github.com/blambeau/alf.git

Everytime I try to add the project, I get a "Invalid git repository or URL" message in the popup window. This is not the first time I encounter such a message... other projects of mine have failed in the past.

I've tried to run the server locally by cloning the git. Everything works fine there. I've looked at the code, but as I'm not able to reproduce the problem on my computer, it's difficult to understand what happens and fix it.

Any hint?

The search function in the upper right corner is not working (rdoc.org, rubydoc.info, rubydoc.org, ....).
Error message:

Oops,
We Couldn't Find That Page

Sorry, but we couldn't find the page /search/stdlib/core/Hash in core. Are you sure that class, method, or file exists?

Probably needs to be done inside the project templates, not the github listing.

http://rdoc.info/github/sinatra/sinatra/master/frames displays the incorrect readme. Locally yard chooses the right one. See our .yardopts.

See lsegal/yard#404 for details.

There seems to be a bug. This screenshot should explain:

http://img.skitch.com/20100922-kcnks7jpb6m59245yaxys3ran4.jpg

Given this configuration in .yardopts:

--markup-provider redcarpet
--markup markdown

... and this code:

```ruby
thing = Thing.new
thing.should do_something
```

This is what shows up on rubydoc.info:

ruby thing = Thing.new thing.should do_something

(See http://rubydoc.info/github/rspec/rspec-mocks/master/file/GFM-TEST.md)

Blurb should have a little info about the doc server (including info about local use?)

Store recently updated projects in either a pstore or (g)dbm-based local store and update as docs are requested / generated. Maybe one column for Gems one column for GitHub? Open to suggestions.

Also add a simple search dialog here (see implementation on gems / github projects index pages).

I naively attempted to use a tag as a commit reference during checkout:

fatal: git checkout: updating paths is incompatible with switching branches.
Did you intend to checkout 'remotes/origin/v0.2.1' which can not be resolved as commit?

This causes the following error:

/Users/nap/dev/yardoc.org/lib/scm_checkout.rb:45:in `initialize': No such file or directory - /Users/nap/dev/yardoc.org/tmp/resque_mailer/zapnap.error.txt (Errno::ENOENT)

But nothing is ever reported to the user. The interface just appears to hang indefinitely.

1. Go to http://rubydoc.info/gems/rspec-core/frames/file/README.md
2. Click on "no frames"

You'll see a 404

For rspec-core, I've got the following in .yardopts:

--no-private
--exclude features
--markup markdown
-
Changelog.md
License.txt

I can see links to Changelog and License at http://rubydoc.info/github/rspec/rspec-core/, but they weren't generated when I released rspec-core-2.8.0: http://rubydoc.info/gems/rspec-core/

When I am looking at a project's docs and I search for a method or class, if I click on the search box and simply press, for instance, arrow-left or arrow-right, an Ajax request is taking place, as evidenced by the spinner. It may seem petty, but it's actually one of those things that makes the UX smoother. I can take a look at this and send you a pull request.

Probably by alpha, like Gem list. Can add proper pagination later.

Not yet sure how to handle GitHub projects that aren't the master fork like this: http://skitch.com/zerosum/d1d84/yard-documentation-server-0.6.0.rc1-library-listing

tl; dr

References to rubydoc.info in other publications are usually about the subject of the docs, not the docs themselves. Since the docs improve from version to version, links within the current version should exclude the version number in the URL, providing the reader with the most up-to-date documentation for the given subject.

The problem

Documentation for any library improves over time, from version to version. If I go to http://rubydoc.info/gems/rspec-core/ and click on Hooks I end up at http://rubydoc.info/gems/rspec-core/2.7.1/RSpec/Core/Hooks. If you follow that link, you'll see, well, not much. Now go to http://rubydoc.info/github/rspec/rspec-core and click on Hooks, which takes you to http://rubydoc.info/github/rspec/rspec-core/master/RSpec/Core/Hooks. When I release 2.8, that's the documentation that will be linked to from http://rubydoc.info/gems/rspec-core/. It's not only better, it's actually existent!

The problem is that someone who is referencing these docs in a blog post or a tweet is very likely to grab the version-specific URL as/is and post it, which means it is soon linking to stale documentation.

Now one might argue that if you're referencing something you want to reference that thing, but I think that's only the case when the documentation itself is the subject of the blog or tweet. Most of the time it's the thing being documented that is the subject, in which case something is lost by linking to the version-specific doc.

Proposed solution

rubydoc.info renders the current version if there is no version in the URL. Since it knows which version is the current version, it could use that knowledge to render links differently for the current version than older versions - without the version number in the URL.

Older versions would render version-specific links. For that to work, when a new version is published, the docs for the previous version would have to be re-generated. Additional overhead, yes, but it seems like a fair tradeoff to me.

Ideally, we'd also account for links that point to docs that existed in older versions but no longer exist in the current version. In that case, we'd either need to redirect to front of the current version with some flash-like message explaining what happened, or index the old versions and find the most recent version that still has that content.

When searching for a gem/project, exact matches should be preferred and at the top of the list.

As an example: Searching for "ramaze" currently yields the results "ns-ramaze-ext" and "ramaze", in that order. "ramaze" should be the first result though, since it exactly matches the search term.

or auto-build docs from rubygems.org post-push hooks...

For example

• http://rdoc.info/stdlib/net/1.8.7/frames - Class List and File List pages are both empty
• http://rdoc.info/stdlib/rubyunit/frames - Class List and Method List pages are both empty, and File List only contains README

Presumably this is not correct?

Is there a way to specify additional files to be included in the doc generation. As far as I can see, only the README and the source codes in lib/ are included. I would like to include other files in other folders as well. Any resolution?

Thanks.

This is a follow-up to lsegal/yard#341. I include files from examples directory in the repository root and it works fine locally but not on rubydoc.info.

hey loren,

this bugged me a couple of time now and i'm not sure if you're aware of it. here's an example:
http://rubydoc.info/gems/savon/0.9.7/file/README.md

any chance rubydoc.info could support those code blocks?

cheers,
daniel

Preferably DM using SQLite (so that a running server is not necessary for users to run this locally)

Extra points for making this work with rubygems list too.

About 12 hours ago I pushed an update to https://github.com/newbamboo/pusher-gem which has a service hook to update http://rubydoc.info/github/newbamboo/pusher-gem/master/frames. However the docs haven't been updated. I assume something has gone wrong?

It would be great if the process was more transparent. What about sending an email when the docs have built / adding github single sign on so I can view my gems / add a link to rebuild docs on demand? Or, crazy talk, adding real time updates of newly built gems using Pusher?!

Service looks great by the way - first time I've taken a look since rdoc.info days - and mighty impressed with yard :) Cheers! Martyn

Stupid-simple rdoc.info-style project search. Hit the filesystem and return matching project names in a view?

I just wanted to take a look at the current docs of Metior when I noticed, that it has vanished from the project listing at http://rubydoc.info/github/m. As you see, there are lots of other projects which names are displayed, but no repositories are linked to them. The direct URL doesn't work either: http://rubydoc.info/github/koraktor/metior/master/frames

I also tried triggering another build with the GitHub hook with no success.

When using the rubydoc.info site's search lately its been returning a 503 Service Temporarily Unavailable error message:

Service Temporarily Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

Apache/2.2.16 (Debian) Server at rubydoc.info Port 80

Should always show the latest commit to master as the default. Currently shows most recently generated docs, which might be for an older commit.

what works for one doesn't work for the other since git checkout handles them differently. example:

fatal: git checkout: updating paths is incompatible with switching branches.
Did you intend to checkout 'remotes/origin/4cc28b09fb54d2d9af61' which can not be resolved as commit?
2010-08-15 16:45:30 -0400: Checkout command (pid 69121 exit 128): cd /Users/nap/dev/yardoc.org/repos/github && mkdir -p resque_mailer/zapnap && cd resque_mailer/zapnap && git clone git://github.com/zapnap/resque_mailer.git 4cc28b09fb54d2d9af61 && cd 4cc28b09fb54d2d9af61 && git fetch && git checkout -b 4cc28b09fb54d2d9af61 --track remotes/origin/4cc28b09fb54d2d9af61 && yardoc -n -q --no-cache && touch .yardoc/complete

codebase needs to be adjusted to either allow the user to specify which they're inputting or just force them to only input branches. branches are more important than tags / commits (use case is stronger).

The project I'm talking about:
http://rubydoc.info/github/robgleeson/minitest-context/master

You can have a look at my .yardopts file here:
https://github.com/robgleeson/minitest-context/blob/master/.yardopts

On rubydoc.info, the frames template correctly displays README.txt inline on index.html.
The non-frames template does not display the README though, as you can see from the link above.

Locally both the frames & non-frames template display README.txt inline on index.html (works as expected).

Trying to use the incremental method/class search with FF9, I get JS errors

event is not defined

in /js/full_list.js (line 25). It looks like the callback for the keyup callback is missing the event parameter.

When I go to http://rubydoc.info/gems/rspec-mocks/frames/file/README.md I see nothing but Top Level Module in the left frame and can't search for any classes/methods.

Just a quick note to self, we should update the "featured" docs at some point to reflect the latest available.

I suggested (https://rubydoc.tenderapp.com/discussions/suggestions/4-suggestion-links-back-to-github) that http://rubydoc.info ought to do this.

Then lsegal suggested it would be best to do this with Javascript. That seemed an odd way to do it, but I said, okay, give it a shot.

Then I wrote this javascript that seems to work pretty darn well if it's applied to any rubydoc.info page in the github area. I just wrote/tested it 'greasemonkey' style, I didn't try running rubydoc.info locally and putting it into source myself.

https://gist.github.com/1305162

Then I realized that in fact these days the majority of my rubygems.info use is for 'gem' area not 'github' area, and this wouldn't do anything for me there, even if the gem source was in github. Then I got depressed and lost interest in spending TOO much more time on this.

Then I noticed that the JS code I wrote conflicts with your JS code for hide/show source. Only because of where it inserts the "link to github" link into the DOM I think. Either it needs to be changed to insert into the DOM somewhere else, or the hide/show source JS needs to be changed to be more precise in it's selectors instead of blindly assuming whatever's next() in the DOM after it is the source.

Now I file a ticket here with my JS code, as lsegal suggested, in case anyone else wants to run with it. I think I'm done. It is pretty cool though! I might make a little JS bookmarklet for myself to use this code, if it doesn't make it into rubydoc.info deployed.

I just tried to add the following repository git://github.com/koraktor/silo.git. The result is Invalid git repository or URL.
I don't know what's causing this, running the command generated by GithubCheckout #git_checkout_command works without problems.

Need a Rake / cron task to remove older docs once in awhile, in order to save space. Can rip off the task that already exists for rdoc.info.

Neither a post-receive hook nor the manual "Add Project" method works.

The latter gives me a "Invalid git repository or URL" error (maybe because of the dash?).

This might require running a git command on the repo to get this information. Could also use git gem. This information should be stored in the DB.

I declare files like tutorials, the license, history, etc in the extra_rdoc_files configuration for a gemspec. These files seem to be ignored by YARD and do not show up in rubydoc.info. For example with the linecook gem you can see there are lots of extra files that are not appearing:

• http://rubydoc.info/gems/linecook/1.2.1/file/README (yardoc)
• https://github.com/pinnacol/linecook (code)

This is a problem IMO because rubydoc.info will be considered canonical because it's what rubygems.org links to. As it stands, the link:files links I setup to work with RDoc appear broken, and the actual files aren't available for people to discover in lieu of a working link.

Is there a recommended way of getting supplementary docs to be included or is this a bug?

Hi Loren,

It seems that permalinks for methods ending with a question mark are not working. For example, clicking on the permalink link of the is_boolean? method returns a 404 not found error:
http://rubydoc.info/github/bytesource/with_validations/master/WithValidations:is_boolean%3F

Best regards,

Stefan

When I go to http://rubydoc.info/github/rspec/rspec-mocks/index I see none of the files that you can see listed in the index for the published gem: http://rubydoc.info/gems/rspec-mocks/index

When I go to http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration and click on #before (under Methods included from #hooks) I go to http://rubydoc.info/gems/rspec-core/RSpec/Core/Hooks#before-instance_method, which is blank.