Hi. I''d really like a Local API for both Ruby *and* rails. Any ideas as to how I can get one? Much like api.rubyonrails.com would be great - I''m a bit surprised it isn''t packaged in the dist, or at least in a package on the d/l page for the dist. Julian.
Julian Leviston <julian@...> writes:> I''d really like a Local API for both Ruby *and* rails. Any ideas as > to how I can get one? Much like api.rubyonrails.com would be greatAssuming you installed Rails via Gems: 1) Run "gem_server" 2) Go to http://localhost:8808/ :sco -- scottraymond.net redgreenblu.com blinksale.com
On 8/28/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote:> Hi. > > I''d really like a Local API for both Ruby *and* rails. Any ideas as > to how I can get one? Much like api.rubyonrails.com would be great - > I''m a bit surprised it isn''t packaged in the dist, or at least in a > package on the d/l page for the dist.Check out: http://www.rubycentral.com/ref/ Ruby isn''t Rails... that would be my guess as to why Ruby docs aren''t included with Rails.
When you installed rails gem packages, it generates rdoc documentation by default. Alternatively, you can always regenerate rdoc for all installed gems with gem rdoc --all Now if you start gem_server on your system, you will be able to access Rails documentation at http://localhost:8808 Go to http://www.ruby-doc.org/stdlib/download.html to see how to install standard ruby library documentation for off-line viewing. The core Ruby API documentation is installed with Ruby itself. it is available immediately with "ri" documentation text browser (you can always generate html documentation with "rdoc" tool). Gennady. On Aug 28, 2005, at 1:06, Julian Leviston wrote:> Hi. > > I''d really like a Local API for both Ruby *and* rails. Any ideas as > to how I can get one? Much like api.rubyonrails.com would be great > - I''m a bit surprised it isn''t packaged in the dist, or at least in > a package on the d/l page for the dist. > > Julian. > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
Julian Leviston wrote:> Hi. > > I''d really like a Local API for both Ruby *and* rails. Any ideas as > to how I can get one? Much like api.rubyonrails.com would be great - > I''m a bit surprised it isn''t packaged in the dist, or at least in a > package on the d/l page for the dist.From page 220 of PickAxe, 2nd addition: from command line type: gem_server Webrick starts up and you have a web interface to all installed gems.
That doesn''t have ruby docs tho... and the link for my rails one is greyed out. Any idea why? Julian. On 29/08/2005, at 4:49 AM, scott raymond wrote:> Julian Leviston <julian@...> writes: > >> I''d really like a Local API for both Ruby *and* rails. Any ideas as >> to how I can get one? Much like api.rubyonrails.com would be great >> > > Assuming you installed Rails via Gems: > > 1) Run "gem_server" > 2) Go to http://localhost:8808/ > > :sco > > -- > scottraymond.net > redgreenblu.com > blinksale.com > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
Yeah, I know Ruby isn''t Rails <sigh> Look at the subject - I''m interested in a _*LOCAL*_ API. As in one on my hard drive, so I can look it up when I''m in transit. So I can refer to the API when I''m not connected to the net... on my laptop. Julian. On 29/08/2005, at 6:57 AM, James Earl wrote:> On 8/28/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote: > >> Hi. >> >> I''d really like a Local API for both Ruby *and* rails. Any ideas as >> to how I can get one? Much like api.rubyonrails.com would be great - >> I''m a bit surprised it isn''t packaged in the dist, or at least in a >> package on the d/l page for the dist. >> > > Check out: > > http://www.rubycentral.com/ref/ > > Ruby isn''t Rails... that would be my guess as to why Ruby docs aren''t > included with Rails. > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
THANK you for the most complete answer I''ve had. :-) If there was a prize, you''d win it. Julian. On 29/08/2005, at 7:05 AM, Gennady Bystritsky wrote:> When you installed rails gem packages, it generates rdoc > documentation by default. Alternatively, you can always regenerate > rdoc for all installed gems with > > gem rdoc --all > > Now if you start gem_server on your system, you will be able to > access Rails documentation at http://localhost:8808 > > Go to http://www.ruby-doc.org/stdlib/download.html to see how to > install standard ruby library documentation for off-line viewing. > > The core Ruby API documentation is installed with Ruby itself. it > is available immediately with "ri" documentation text browser (you > can always generate html documentation with "rdoc" tool). > > Gennady. > > On Aug 28, 2005, at 1:06, Julian Leviston wrote: > > >> Hi. >> >> I''d really like a Local API for both Ruby *and* rails. Any ideas >> as to how I can get one? Much like api.rubyonrails.com would be >> great - I''m a bit surprised it isn''t packaged in the dist, or at >> least in a package on the d/l page for the dist. >> >> Julian. >> _______________________________________________ >> Rails mailing list >> Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org >> http://lists.rubyonrails.org/mailman/listinfo/rails >> >> > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
Rails itself does not have the documentation, as it a thing that works under the hood. It encompasses activepack, activerecords, avctivemailer, etc. Those are what you should check the documentation for. As has been indicated several times, Ruby comes with its own documentation, not available via gem_server. The most convenient way to browse Ruby documentation is with ''ri''. Gennady. On Aug 29, 2005, at 3:24, Julian Leviston wrote:> That doesn''t have ruby docs tho... and the link for my rails one is > greyed out. Any idea why? > > Julian. > > > On 29/08/2005, at 4:49 AM, scott raymond wrote: > > >> Julian Leviston <julian@...> writes: >> >> >>> I''d really like a Local API for both Ruby *and* rails. Any ideas as >>> to how I can get one? Much like api.rubyonrails.com would be great >>> >>> >> >> Assuming you installed Rails via Gems: >> >> 1) Run "gem_server" >> 2) Go to http://localhost:8808/ >> >> :sco >> >> -- >> scottraymond.net >> redgreenblu.com >> blinksale.com >> >> >> _______________________________________________ >> Rails mailing list >> Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org >> http://lists.rubyonrails.org/mailman/listinfo/rails >> >> > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
rails doesn''t have docs itself. The rails gem only aggregates the sub-packages (ActionPack, ActiveRecord, etc) . On 29/08/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote:> That doesn''t have ruby docs tho... and the link for my rails one is > greyed out. Any idea why? > > Julian. > > > On 29/08/2005, at 4:49 AM, scott raymond wrote: > > > Julian Leviston <julian@...> writes: > > > >> I''d really like a Local API for both Ruby *and* rails. Any ideas as > >> to how I can get one? Much like api.rubyonrails.com would be great > >> > > > > Assuming you installed Rails via Gems: > > > > 1) Run "gem_server" > > 2) Go to http://localhost:8808/ > > > > :sco > > > > -- > > scottraymond.net > > redgreenblu.com > > blinksale.com > > > > > > _______________________________________________ > > Rails mailing list > > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > > http://lists.rubyonrails.org/mailman/listinfo/rails > > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >-- Florian Ebeling florian.ebeling-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Julian Leviston wrote: | Yeah, I know Ruby isn''t Rails <sigh> | Look at the subject - I''m interested in a _*LOCAL*_ API. As in one on wget -r -np www.ruby-doc.org/core | my hard drive, so I can look it up when I''m in transit. So I can refer | to the API when I''m not connected to the net... on my laptop. | Julian. - -- Derek Wyatt - C++ / Ruby / Unix Programmer http://derekwyatt.org -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (MingW32) iD8DBQFDFEerwwHFeC88e2IRAiWoAKDh8QAh8OBjQEjHBas2XeNUnJhGRACfYmhW 52Qzg7MnhjenIQr9dLzlYDI=zJZz -----END PGP SIGNATURE-----
Hi Julian, If you are using Firefox, this plugin is pretty nice. It contains both Ruby and Rails docs amongst others. You would want the offline version. http://www.martincohen.info/download/devboi_with_rails/ Tom On 8/29/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote:> > Yeah, I know Ruby isn''t Rails <sigh> > Look at the subject - I''m interested in a _*LOCAL*_ API. As in one on > my hard drive, so I can look it up when I''m in transit. So I can > refer to the API when I''m not connected to the net... on my laptop. > Julian. > > On 29/08/2005, at 6:57 AM, James Earl wrote: > > > On 8/28/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote: > > > >> Hi. > >> > >> I''d really like a Local API for both Ruby *and* rails. Any ideas as > >> to how I can get one? Much like api.rubyonrails.com<http://api.rubyonrails.com>would be great - > >> I''m a bit surprised it isn''t packaged in the dist, or at least in a > >> package on the d/l page for the dist. > >> > > > > Check out: > > > > http://www.rubycentral.com/ref/ > > > > Ruby isn''t Rails... that would be my guess as to why Ruby docs aren''t > > included with Rails. > > _______________________________________________ > > Rails mailing list > > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > > http://lists.rubyonrails.org/mailman/listinfo/rails > > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >_______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails
I''m with you, Julian. We speak gem_server. On 29/08/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote:> Yeah, I know Ruby isn''t Rails <sigh> > Look at the subject - I''m interested in a _*LOCAL*_ API. As in one on > my hard drive, so I can look it up when I''m in transit. So I can > refer to the API when I''m not connected to the net... on my laptop. > Julian. > > On 29/08/2005, at 6:57 AM, James Earl wrote: > > > On 8/28/05, Julian Leviston <julian-AfxEtdRqmE/tt0EhB6fy4g@public.gmane.org> wrote: > > > >> Hi. > >> > >> I''d really like a Local API for both Ruby *and* rails. Any ideas as > >> to how I can get one? Much like api.rubyonrails.com would be great - > >> I''m a bit surprised it isn''t packaged in the dist, or at least in a > >> package on the d/l page for the dist. > >> > > > > Check out: > > > > http://www.rubycentral.com/ref/ > > > > Ruby isn''t Rails... that would be my guess as to why Ruby docs aren''t > > included with Rails. > > _______________________________________________ > > Rails mailing list > > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > > http://lists.rubyonrails.org/mailman/listinfo/rails > > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >-- Florian Ebeling florian.ebeling-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
> > So I can > > refer to the API when I''m not connected to the net... on my laptop. >I''m with you, Julian. We speak gem_server.This was only the answer to why the rails doc link is greyed out. For ruby standard library you can use the ri command, like this $ ri Array#each