rubydoc-devel-cvs Mailing List for rubydoc: ruby docs via CLI and WWW
Status: Pre-Alpha
Brought to you by:
thetitan
Menu
▾
▴
rubydoc-devel-cvs — cvs commit list
You can subscribe to this list here.
| 2001 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
(7) |
Sep
(1) |
Oct
|
Nov
|
Dec
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2002 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(2) |
Jun
(2) |
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: Sean C. <the...@us...> - 2002-06-28 21:41:57
|
Update of /cvsroot/rubydoc/www/docs
In directory usw-pr-cvs1:/tmp/cvs-serv12550/docs
Modified Files:
index.html
Log Message:
*) Updated and added a link to the rubydoc homepage
Index: index.html
===================================================================
RCS file: /cvsroot/rubydoc/www/docs/index.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.html 29 Aug 2001 19:54:48 -0000 1.2
+++ index.html 28 Jun 2002 21:41:54 -0000 1.3
@@ -8,20 +8,30 @@
<h1>rubydoc</h1>
- <p>In a nutshell, this is the vision for rubydoc:</p>
+ <p>
+ To see/read/reference rubydoc, please visit its homepage at <a
+ href="http://www.rubydoc.org/">http://www.rubydoc.org/</a>.
+ </p>
- <ol>
- <li>A command line tool that allows for easy access to ruby documentation.</li>
+ <h1>rubydoc Technical Plan</h1>
+
+ <p>
+ In a nutshell, this is the vision for rubydoc is to create a
+ command line and online tool that allows for multi-lingual
+ access to ruby documentation for builtin and external modules.
+ More specifically, some of the project goals are to:
+ </p>
+ <ol>
<li>
- An online initiative aimed at collecting user feedback,
+ Create an online foum aimed at collecting user feedback,
experiences, and stories with ruby classes and modules (hosted
on rubydoc.org).
</li>
<li>
- A compolation tool used to dump the collected from the online
- forum into a distributable medium so that comments are
+ Extract the user comments and dump the collected data from the
+ online forum into a distributable medium so that comments are
available from the CLI (data probably stored in rd or XML).
</li>
|
|
From: Sean C. <the...@us...> - 2002-06-10 20:36:55
|
Update of /cvsroot/rubydoc/rubydoc In directory usw-pr-cvs1:/tmp/cvs-serv16234 Added Files: SPEC Log Message: *) A quick two bits on rubydoc --- NEW FILE: SPEC --- # See the LICENSE file for copyright and distribution information. # # $Id: SPEC,v 1.1 2002/06/10 20:36:52 thetitan Exp $ A quick ditty about how rubydoc will work: * Rubydoc piggy-backs ontop of rd documentation. A rubydoc section starts with a '=begin' tag and ends with a '=end' tag and are therefore automatically ignored by the Ruby parser. * Rubydoc is XML embedded in rd comments (=begin/=end blocks) * Rubydoc may possibly use DocBook verbatim, but will likely be a knock off of DocBook * rubydoc is a CLI that looks for Rubydoc XML in a module or in a document cache and formats it for review by users. * 'rubydoc --extract [module_name]' finds and echo's rubydoc comments from a file and prints them to stdout. * 'rubydoc --install [module_name]' extracts the rubydoc comments from a file and puts them in the central document cache/folder. Does it modify the file? * rubydoc is a wrapper around many smaller libraries and modules and is essentially a getopt parser and library goo machine, similar to the rubynet CLI. * rubydoc should have a --publish option/library that lets module authors publish updated documentation to a rubynet server. * 'rubydoc --output=[format] [module_name]' loads the xslt stylesheet corresponding to [format] and parses over the rubydoc comments found for [module_name] and prints the result to stdout after it has been translated by the stylesheet. |
|
From: Sean C. <the...@us...> - 2002-05-18 07:21:15
|
Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv5257
Modified Files:
VISION
Log Message:
*) gsub(/SOAP/, 'REST') # SOAP should die a quick and painful death: REST
# is open source's new best friend
Index: VISION
===================================================================
RCS file: /cvsroot/rubydoc/rubydoc/VISION,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- VISION 18 May 2002 04:54:28 -0000 1.2
+++ VISION 18 May 2002 07:21:12 -0000 1.3
@@ -13,7 +13,7 @@
support for DocBook).
4) A CLI that will let you, if you have a net connection, browse the
- online rubydoc comments (probably SOAP).
+ online rubydoc comments (via REST).
5) rubydoc is a cross between perldoc and the PHP documentation at
php.net.
|
|
From: Sean C. <the...@us...> - 2002-05-18 04:54:31
|
Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv12889
Modified Files:
VISION
Log Message:
*) Might as well update this given that I'm getting closer to actually diving
into code
*) Updated VISION to include explicit mention of the use of DocBook in
rubydoc
*) Explain that a rubydoc file will be a distribution package that can be
untar'ed and extracted into runtime components upon installation.
*) XML is the wrapper for distribution. MIME64 encoded binary files (gzipped
sources, images, sources, or otherwise) included in the XML will be the
distribution mechanisms.
Index: VISION
===================================================================
RCS file: /cvsroot/rubydoc/rubydoc/VISION,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- VISION 29 Aug 2001 19:03:33 -0000 1.1
+++ VISION 18 May 2002 04:54:28 -0000 1.2
@@ -9,7 +9,8 @@
3) A compolation tool used to dump the collected from the online forum
into a distributable medium so that comments are available from the
- CLI (data probably stored in rd or XML).
+ CLI (data probably stored in DocBook XML: need to vamp up Ruby's
+ support for DocBook).
4) A CLI that will let you, if you have a net connection, browse the
online rubydoc comments (probably SOAP).
@@ -25,6 +26,16 @@
8) The online forum will have user accounts and watches to allow
people to track comments and/or official documentation changes.
+
+9) rubydoc should contain the actual scripts, C files (source and
+ headers), external data such as images (MIME64 encoded) and the
+ documentation in one big goo file. Many files into one rubydoc
+ file. A rubydoc file gets distributed and is the package. A
+ rubypkg or rubygem (Ruby's equiv of a JAR file) is built from a
+ rubydoc package. rubydoc will be based on DocBook 4.1 or later
+ with customized Ruby extensions.
+
+10) rubydoc will support converting to and from rdoc.
If you have any questions/comments, please send them to:
<rub...@li...>
|
|
From: Sean C. <the...@us...> - 2001-09-02 18:38:38
|
Update of /cvsroot/rubydoc/www In directory usw-pr-cvs1:/tmp/cvs-serv7086 Modified Files: Makefile Log Message: A user can be specified in a ~/.ssh/config file w/ the User directive Index: Makefile =================================================================== RCS file: /cvsroot/rubydoc/www/Makefile,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- Makefile 2001/08/29 19:16:06 1.1 +++ Makefile 2001/09/02 18:38:35 1.2 @@ -1,3 +1,3 @@ push: @echo "Pushing out rubydoc..." - @rsync --progress --stats --delete -Ctvrc docs/ the...@ru...:live/rubydoc-www/htdocs/ + @rsync --progress --stats --delete -Ctvrc docs/ rubydoc.sourceforge.net:live/rubydoc-www/htdocs/ |
|
From: Sean C. <the...@us...> - 2001-08-29 19:54:51
|
Update of /cvsroot/rubydoc/www/docs
In directory usw-pr-cvs1:/tmp/cvs-serv9494
Modified Files:
index.html
Log Message:
Added a link to download
Index: index.html
===================================================================
RCS file: /cvsroot/rubydoc/www/docs/index.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.html 2001/08/29 19:15:53 1.1
+++ index.html 2001/08/29 19:54:48 1.2
@@ -54,8 +54,21 @@
<p>
If you have any questions/comments, please send them to: <a
href="mailto:rub...@li...">rub...@li...</a>.
+ </p>
+
+ <p>
To subscribe to the mailing list: <a
href="http://lists.sourceforge.net/lists/listinfo/rubydoc-devel">http://lists.sourceforge.net/lists/listinfo/rubydoc-devel</a>.
</p>
+
+ <p>
+ To download rubydoc, click <a
+ href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/rubydoc/rubydoc/src/rubydoc?rev=1.1">here</a>
+ to download it, then save it to a directory in your path, and
+ chmod it to 755 (note, you may have to restart you shell (exec
+ bash|exec tcsh) for your shell to find it in your path. Send
+ all problems and bugs to the rubydoc-devel list mentioned
+ earlier. -sc
+ </p>
</body>
-</html>
+</html>
\ No newline at end of file
|
|
From: Sean C. <the...@us...> - 2001-08-29 19:16:10
|
Update of /cvsroot/rubydoc/www In directory usw-pr-cvs1:/tmp/cvs-serv20426 Added Files: Makefile Log Message: Want to push stuff out easily --- NEW FILE: Makefile --- push: @echo "Pushing out rubydoc..." @rsync --progress --stats --delete -Ctvrc docs/ the...@ru...:live/rubydoc-www/htdocs/ |
|
From: Sean C. <the...@us...> - 2001-08-29 19:15:57
|
Update of /cvsroot/rubydoc/www/docs
In directory usw-pr-cvs1:/tmp/cvs-serv20295/docs
Added Files:
index.html
Log Message:
Main page... checked in the vision statement
--- NEW FILE: index.html ---
<html>
<head>
<title>rubydoc</title>
</head>
<body bgcolor="#ffffff">
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=31088" width="88" height="31" border="0" alt="SourceForge Logo"></a>
<h1>rubydoc</h1>
<p>In a nutshell, this is the vision for rubydoc:</p>
<ol>
<li>A command line tool that allows for easy access to ruby documentation.</li>
<li>
An online initiative aimed at collecting user feedback,
experiences, and stories with ruby classes and modules (hosted
on rubydoc.org).
</li>
<li>
A compolation tool used to dump the collected from the online
forum into a distributable medium so that comments are
available from the CLI (data probably stored in rd or XML).
</li>
<li>
A CLI that will let you, if you have a net connection, browse
the online rubydoc comments (probably SOAP).
</li>
<li>
rubydoc is a cross between perldoc and the PHP documentation at php.net.
</li>
<li>
rubydoc is set to evolve with the language and be defined
through its user community.
</li>
<li>
rubydoc will use the reflection API to make all methods
available for comment and user review.
</li>
<li>
The online forum will have user accounts and watches to allow
people to track comments and/or official documentation
changes.
</li>
</ol>
<p>
If you have any questions/comments, please send them to: <a
href="mailto:rub...@li...">rub...@li...</a>.
To subscribe to the mailing list: <a
href="http://lists.sourceforge.net/lists/listinfo/rubydoc-devel">http://lists.sourceforge.net/lists/listinfo/rubydoc-devel</a>.
</p>
</body>
</html>
|
|
From: Sean C. <the...@us...> - 2001-08-29 19:04:41
|
Update of /cvsroot/rubydoc/www/docs In directory usw-pr-cvs1:/tmp/cvs-serv13329/docs Log Message: Directory /cvsroot/rubydoc/www/docs added to the repository |
|
From: Sean C. <the...@us...> - 2001-08-29 19:03:36
|
Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv12491
Added Files:
LICENSE Makefile README VISION
Log Message:
Initial checkin for the rubydoc project.
Functioning rubydoc included
--- NEW FILE: LICENSE ---
# $Id: LICENSE,v 1.1 2001/08/29 19:03:33 thetitan Exp $
All of the documentation and software included in rubydoc releases is
copyrighted by Sean Chittenden <se...@ch...>
Copyright 2001
Sean Chittenden <se...@ch...>. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgment:
This product includes software developed by Sean Chittenden
<se...@ch...> and rubydoc's contributors.
4. Neither the name of the software nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
If you have any questions regarding the redistribution of this software,
please contact the author at <se...@ch...>.
--- NEW FILE: Makefile ---
# $Id: Makefile,v 1.1 2001/08/29 19:03:33 thetitan Exp $
install:
install -c -m 555 -o 0 -g 0 src/rubydoc /usr/local/bin/rubydoc
uninstall:
rm -f /usr/local/bin/rubydoc
--- NEW FILE: README ---
To install:
install rd2 (part of ruby-rdtool package)
make install
--- NEW FILE: VISION ---
In a nutshell, this is what I want rubydoc to be:
1) A command line tool that allows for easy access to ruby
documentation.
2) An online initiative aimed at collecting user feedback,
experiences, and stories with ruby classes and modules (hosted on
rubydoc.org).
3) A compolation tool used to dump the collected from the online forum
into a distributable medium so that comments are available from the
CLI (data probably stored in rd or XML).
4) A CLI that will let you, if you have a net connection, browse the
online rubydoc comments (probably SOAP).
5) rubydoc is a cross between perldoc and the PHP documentation at
php.net.
6) rubydoc is set to evolve with the language and be defined through
its user community.
7) rubydoc will use the reflection API to make all methods available
for comment and user review.
8) The online forum will have user accounts and watches to allow
people to track comments and/or official documentation changes.
If you have any questions/comments, please send them to:
<rub...@li...>
To subscribe to the mailing list:
http://lists.sourceforge.net/lists/listinfo/rubydoc-devel
|
|
From: Sean C. <the...@us...> - 2001-08-29 19:03:36
|
Update of /cvsroot/rubydoc/rubydoc/src
In directory usw-pr-cvs1:/tmp/cvs-serv12491/src
Added Files:
rubydoc
Log Message:
Initial checkin for the rubydoc project.
Functioning rubydoc included
--- NEW FILE: rubydoc ---
#!/usr/bin/env ruby
# All of the documentation and software included in rubydoc releases is
# copyrighted by Sean Chittenden <se...@ch...>
#
# Copyright 2001
# Sean Chittenden <se...@ch...>. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. All advertising materials mentioning features or use of this software
# must display the following acknowledgment:
#
# This product includes software developed by Sean Chittenden
# <se...@ch...> and rubydoc's contributors.
#
# 4. Neither the name of the software nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# If you have any questions regarding the redistribution of this software,
# please contact the author at <se...@ch...>.
require 'getoptlong'
options = {
'path' => $:.dup
}
opts = GetoptLong.new([ "--include", "-I", GetoptLong::REQUIRED_ARGUMENT ],
[ "--rd2-path", "-r", GetoptLong::REQUIRED_ARGUMENT ])
begin
opts.quiet = true
opts.each do |opt, arg|
case opt
when '--include'
options['path'].unshift(arg)
when '--rd2-path'
options['rd2path'] = arg
end
end
rescue GetoptLong::InvalidOption
puts $0 + ": " + $!
exit
end
def find_module (paths, lib)
lib_parts = lib.gsub(/\:\:/, File::SEPARATOR)
paths.each do |p|
['', '.rb'].each do |s|
begin
file_path = File.join(p, lib_parts + (s.length > 0 ? '.' + s : ''))
if File.stat(file_path).readable? and File.stat(file_path).file?
return(file_path)
end
rescue
end
end # suffixes.each
end # paths.each
return
end # find_module
def print_module ( full_mod_path )
return unless full_mod_path
puts open ("|rd2 -rrd/rd2man-lib.rb #{full_mod_path} | nroff -man").readlines.to_s
end # def print_module
ARGV.each do |a|
full_mod_path = find_module(options['path'], a)
print_module(full_mod_path)
end # args.each
|
|
From: Sean C. <the...@us...> - 2001-08-29 03:10:10
|
Update of /cvsroot/rubydoc/rubydoc/src In directory usw-pr-cvs1:/tmp/cvs-serv10458/src Log Message: Directory /cvsroot/rubydoc/rubydoc/src added to the repository |
