Skip to content
Browse files

switched from rdoc to yard

  • Loading branch information...
1 parent a0edf5a commit 6196f20c16ec3ec8dfddbee4dd877cb408df940a @jmettraux committed Sep 2, 2009
Showing with 54 additions and 385 deletions.
  1. +45 −45 README.txt
  2. +9 −20 Rakefile
  3. +0 −320 doc/rdoc-style.css
View
90 README.txt
@@ -4,7 +4,7 @@
== getting it
- sudo gem install -y rufus-rtm
+ sudo gem install -y rufus-rtm
or at
@@ -26,80 +26,80 @@ You have to apply for the first two ones at http://www.rememberthemilk.com/servi
Once you have the API key and the shared secret, you have to get the frob and the auth token. Fire your 'irb' and
- >> require 'rubygems'
- >> require 'rufus/rtm'
+ >> require 'rubygems'
+ >> require 'rufus/rtm'
- please visit this URL with your browser and then hit 'enter' :
+ please visit this URL with your browser and then hit 'enter' :
- http://www.rememberthemilk.com/services/auth/?api_sig=70036e47c38da170fee431f04e29e8f0&frob=fa794036814b78fddf3e5641fe7c37f80e7d91fc&perms=delete&api_key=7f07e4fc5a944bf8c02a7d1e45c79346
+ http://www.rememberthemilk.com/services/auth/?api_sig=70036e47c38da170fee431f04e29e8f0&frob=fa794036814b78fddf3e5641fe7c37f80e7d91fc&perms=delete&api_key=7f07e4fc5a944bf8c02a7d1e45c79346
visit, the given URL, you should finally be greeted by a message like "You have successfully authorized the application API Application. You may now close this window and continue the authentication process with the application that sent you here.", hit enter...
- ok, now getting auth token...
+ ok, now getting auth token...
- here are your RTM_FROB and RTM_AUTH_TOKEN, make sure to place them
- in your environment :
+ here are your RTM_FROB and RTM_AUTH_TOKEN, make sure to place them
+ in your environment :
- export RTM_FROB=3cef465718317b837eec2faeb5340fe777d55c7c
- export RTM_AUTH_TOKEN=ca0022d705ea1831543b7cdd2d7e3d707a0e1efb
+ export RTM_FROB=3cef465718317b837eec2faeb5340fe777d55c7c
+ export RTM_AUTH_TOKEN=ca0022d705ea1831543b7cdd2d7e3d707a0e1efb
make then sure that all the 4 variables are set in the environment you use for running 'rufus-rtm'.
== usage
- require 'rubygems'
- require 'rufus/rtm'
+ require 'rubygems'
+ require 'rufus/rtm'
- include Rufus::RTM
+ include Rufus::RTM
- #
- # listing tasks
+ #
+ # listing tasks
- tasks = Task.find
- # finding all the tasks
+ tasks = Task.find
+ # finding all the tasks
- tasks = Task.find :filter => "status:incomplete"
- # finding all the incomplete tasks
+ tasks = Task.find :filter => "status:incomplete"
+ # finding all the incomplete tasks
- tasks.each do |task|
+ tasks.each do |task|
- puts "task id #{task.task_id}"
- puts " #{task.name} (#{task.tags.join(",")})"
- puts
- end
+ puts "task id #{task.task_id}"
+ puts " #{task.name} (#{task.tags.join(",")})"
+ puts
+ end
- #
- # adding a task
+ #
+ # adding a task
- task = Task.add! "study this rufus-rtm gem"
- # gets added to the 'Inbox' by default
+ task = Task.add! "study this rufus-rtm gem"
+ # gets added to the 'Inbox' by default
- puts "task id is #{task.task_id}"
+ puts "task id is #{task.task_id}"
- #
- # enumerating lists
+ #
+ # enumerating lists
- lists = List.find
+ lists = List.find
- w = lists.find { |l| l.name == 'Work' }
+ w = lists.find { |l| l.name == 'Work' }
- puts "my Work list id is #{w.list_id}"
+ puts "my Work list id is #{w.list_id}"
- #
- # adding a task to a list
+ #
+ # adding a task to a list
- task = Task.add! "work, more work", w.list_id
+ task = Task.add! "work, more work", w.list_id
- #
- # completing a task
+ #
+ # completing a task
- task.complete!
+ task.complete!
- #
- # deleting a task
+ #
+ # deleting a task
- task.delete!
+ task.delete!
Note that the methods that change the state of the Remember The Milk dataset have names ending with an exclamation mark.
@@ -123,7 +123,7 @@ The gem 'rufus-verbs' (http://rufus.rubyforge.org/rufus-verbs)
On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
- http://groups.google.com/group/rufus-ruby
+http://groups.google.com/group/rufus-ruby
== issue tracker
@@ -135,7 +135,7 @@ http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
http://github.com/jmettraux/rufus-rtm
- git clone git://github.com/jmettraux/rufus-rtm.git
+ git clone git://github.com/jmettraux/rufus-rtm.git
== author
View
29 Rakefile
@@ -8,7 +8,7 @@ require 'rake/gempackagetask'
require 'rake/testtask'
#require 'rake/rdoctask'
-require 'hanna/rdoctask'
+#require 'hanna/rdoctask'
gemspec = File.read('rufus-rtm.gemspec')
@@ -73,31 +73,20 @@ end
#
# DOCUMENTATION
-Rake::RDocTask.new do |rd|
-
- rd.main = 'README.txt'
- rd.rdoc_dir = 'html/rufus-rtm'
- rd.rdoc_files.include(
- 'README.txt',
- 'CHANGELOG.txt',
- 'LICENSE.txt',
- #'CREDITS.txt',
- 'lib/**/*.rb')
- #rd.rdoc_files.exclude('lib/tokyotyrant.rb')
- rd.title = 'rufus-rtm rdoc'
- rd.options << '-N' # line numbers
- rd.options << '-S' # inline source
-end
-
-task :rrdoc => :rdoc do
- FileUtils.cp('doc/rdoc-style.css', 'html/rufus-rtm/')
+task :rdoc do
+ sh %{
+ rm -fR rdoc
+ yardoc 'lib/**/*.rb' \
+ -o html/rufus-rtm \
+ --title 'rufus-rtm'
+ }
end
#
# WEBSITE
-task :upload_website => [ :clean, :rrdoc ] do
+task :upload_website => [ :clean, :rdoc ] do
account = 'jmettraux@rubyforge.org'
webdir = '/var/www/gforge-projects/rufus'
View
320 doc/rdoc-style.css
@@ -1,320 +0,0 @@
-html, body {
- height: 100%; }
-
-body {
- font-family: Helvetica Neue, Helvetica, sans-serif;
- font-size: 85%;
- margin: 0;
- padding: 0;
- background: white;
- color: black; }
-
-#wrapper {
- min-height: 100%;
- height: auto !important;
- height: 100%;
- margin: 0 auto -43px; }
-
-#footer-push {
- height: 43px; }
-
-div.header, #footer {
- background: #eee; }
-
-#footer {
- border-top: 1px solid silver;
- margin-top: 12px;
- padding: 0 2em;
- line-height: 30px;
- text-align: center;
- font-variant: small-caps;
- font-size: 95%; }
-
-.clearing:after {
- content: ".";
- visibility: hidden;
- height: 0;
- display: block;
- clear: both; }
-* html .clearing {
- height: 1px; }
-.clearing *:first-child + html {
- overflow: hidden; }
-
-h1, h2, h3, h4, h5, h6 {
- margin: 0;
- font-weight: normal; }
-
-a {
- color: #0b3e71; }
- a:hover {
- background: #336699;
- text-decoration: none;
- color: #eef; }
-
-#diagram img {
- border: 0; }
-
-#description a, .method .description a, .header a {
- color: #336699; }
- #description a:hover, .method .description a:hover, .header a:hover {
- color: #eee; }
-#description h1 a, #description h2 a, #description h3 a, #description h4 a, #description h5 a, #description h6 a, .method .description h1 a, .method .description h2 a, .method .description h3 a, .method .description h4 a, .method .description h5 a, .method .description h6 a, .header h1 a, .header h2 a, .header h3 a, .header h4 a, .header h5 a, .header h6 a {
- color: #0b3e71; }
-
-ol {
- margin: 0;
- padding: 0;
- list-style: none; }
- ol li {
- margin-left: 0;
- white-space: nowrap; }
- ol li.other {
- display: none; }
-
-ol.expanded li.other {
- display: list-item; }
-
-table {
- margin-bottom: 1em;
- font-size: 1em;
- border-collapse: collapse; }
- table td, table th {
- padding: .4em .8em; }
- table thead {
- background-color: #e8e8e8; }
- table thead th {
- font-variant: small-caps;
- color: #666666; }
- table tr {
- border-bottom: 1px solid silver; }
-
-#index a.show, div.header a.show {
- text-decoration: underline;
- font-style: italic;
- color: #666666; }
- #index a.show:after, div.header a.show:after {
- content: " ..."; }
- #index a.show:hover, div.header a.show:hover {
- color: black;
- background: #ffe; }
-
-#index {
- font: 85%/1.2 Helvetica neue, Helvetica, sans-serif; }
- #index a {
- text-decoration: none; }
- #index h1 {
- padding: .2em .5em .1em;
- background: #ccc;
- font: small-caps 1.2em Helvetica Neue, Helvetica, sans-serif;
- color: #333;
- border-bottom: 1px solid gray; }
- #index form {
- margin: 0;
- padding: 0; }
- #index form input {
- margin: .4em;
- margin-bottom: 0;
- width: 90%; }
- #index form #search.untouched {
- color: #777777; }
- #index ol {
- padding: .4em .5em; }
- #index ol li {
- white-space: nowrap; }
- #index #index-entries li a {
- padding: 1px 2px; }
- #index #index-entries.classes {
- font-size: 1.1em; }
- #index #index-entries.classes ol {
- padding: 0; }
- #index #index-entries.classes span.nodoc {
- display: none; }
- #index #index-entries.classes span.nodoc, #index #index-entries.classes a {
- font-weight: bold; }
- #index #index-entries.classes .parent {
- font-weight: normal; }
- #index #index-entries.methods li, #index #search-results.methods li {
- margin-bottom: 0.2em; }
- #index #index-entries.methods li a .method_name, #index #search-results.methods li a .method_name {
- margin-right: 0.25em; }
- #index #index-entries.methods li a .module_name, #index #search-results.methods li a .module_name {
- color: #666666; }
- #index #index-entries.methods li a:hover .module_name, #index #search-results.methods li a:hover .module_name {
- color: #ddd; }
-
-div.header {
- font-size: 80%;
- padding: .5em 2%;
- font-family: Helvetica, sans-serif;
- border-bottom: 1px solid silver; }
- div.header .name {
- font-size: 1.6em;
- font-family: Helvetica, sans-serif; }
- div.header .name .type {
- color: #666666;
- font-size: 80%;
- font-variant: small-caps; }
- div.header h1.name {
- font-size: 2.2em; }
- div.header .paths, div.header .last-update, div.header .parent {
- color: #666666; }
- div.header .last-update .datetime {
- color: #484848; }
- div.header .parent {
- margin-top: .3em; }
- div.header .parent strong {
- font-weight: normal;
- color: #484848; }
-
-#content {
- padding: 12px 2%; }
- div.class #content {
- position: relative;
- width: 72%; }
- #content pre, #content .method .synopsis {
- font: 14px Monaco, DejaVu Sans Mono , Bitstream Vera Sans Mono , Courier New , monospace; }
- #content pre {
- color: black;
- background: #eee;
- border: 1px solid silver;
- padding: .5em .8em;
- overflow: auto; }
- #content p code, #content p tt, #content li code, #content li tt, #content dl code, #content dl tt {
- font: 14px Monaco, DejaVu Sans Mono , Bitstream Vera Sans Mono , Courier New , monospace;
- background: #ffffe3;
- padding: 2px 3px;
- line-height: 1.4; }
- #content h1 code, #content h1 tt, #content h2 code, #content h2 tt, #content h3 code, #content h3 tt, #content h4 code, #content h4 tt, #content h5 code, #content h5 tt, #content h6 code, #content h6 tt {
- font-size: 1.1em; }
- #content #text {
- position: relative; }
- #content #description p {
- margin-top: .5em; }
- #content #description h1, #content #description h2, #content #description h3, #content #description h4, #content #description h5, #content #description h6 {
- font-family: Helvetica Neue, Helvetica, sans-serif; }
- #content #description h1 {
- font-size: 2.2em;
- margin-bottom: .2em;
- border-bottom: 3px double #d8d8d8;
- padding-bottom: .1em; }
- #content #description h2 {
- font-size: 1.8em;
- color: #0e3062;
- margin: .8em 0 .3em 0; }
- #content #description h3 {
- font-size: 1.6em;
- margin: .8em 0 .3em 0;
- color: #666666; }
- #content #description h4 {
- font-size: 1.4em;
- margin: .8em 0 .3em 0; }
- #content #description h5 {
- font-size: 1.2em;
- margin: .8em 0 .3em 0;
- color: #0e3062; }
- #content #description h6 {
- font-size: 1.0em;
- margin: .8em 0 .3em 0;
- color: #666666; }
- #content #description ul, #content #description ol, #content .method .description ul, #content .method .description ol {
- margin: .8em 0;
- padding-left: 1.5em; }
- #content #description ol, #content .method .description ol {
- list-style: decimal; }
- #content #description ol li, #content .method .description ol li {
- white-space: normal; }
-
-#method-list {
- position: absolute;
- top: 0px;
- right: -33%;
- width: 28%;
- background: #eee;
- border: 1px solid silver;
- padding: .4em 1%;
- overflow: hidden; }
- #method-list h2 {
- font-size: 1.3em; }
- #method-list h3 {
- font-variant: small-caps;
- text-transform: capitalize;
- font-family: Helvetica Neue, Helvetica, sans-serif;
- color: #666;
- font-size: 1.1em; }
- #method-list ol {
- padding: 0 0 .5em .5em; }
-
-#context {
- border-top: 1px dashed silver;
- margin-top: 1em;
- margin-bottom: 1em; }
-
-#context h2, #section h2 {
- font: small-caps 1.2em Helvetica Neue, Helvetica, sans-serif;
- color: #444;
- margin: 1em 0 .2em 0; }
-
-#methods .method {
- border: 1px solid silver;
- margin-top: .5em;
- background: #eee; }
- #methods .method .synopsis {
- color: black;
- background: silver;
- padding: .2em 1em; }
- #methods .method .synopsis .name {
- font-weight: bold; }
- #methods .method .synopsis a {
- text-decoration: none; }
- #methods .method .description {
- padding: 0 1em; }
- #methods .method .description pre {
- background: #f8f8f8; }
- #methods .method .source {
- margin: .5em 0; }
- #methods .method .source-toggle {
- font-size: 85%;
- margin-left: 1em; }
-#methods .public-class {
- background: #ffffe4; }
-#methods .public-instance .synopsis {
- color: #eee;
- background: #336699; }
-
-#content .method .source pre {
- font-size: 90%;
- background: #262626;
- color: #ffdead;
- margin: 1em;
- padding: 0.5em;
- border: 1px dashed #999;
- overflow: auto; }
- #content .method .source pre .ruby-constant {
- color: #7fffd4;
- background: transparent; }
- #content .method .source pre .ruby-keyword {
- color: #00ffff;
- background: transparent; }
- #content .method .source pre .ruby-ivar {
- color: #eedd82;
- background: transparent; }
- #content .method .source pre .ruby-operator {
- color: #00ffee;
- background: transparent; }
- #content .method .source pre .ruby-identifier {
- color: #ffdead;
- background: transparent; }
- #content .method .source pre .ruby-node {
- color: #ffa07a;
- background: transparent; }
- #content .method .source pre .ruby-comment {
- color: #b22222;
- font-weight: bold;
- background: transparent; }
- #content .method .source pre .ruby-regexp {
- color: #ffa07a;
- background: transparent; }
- #content .method .source pre .ruby-value {
- color: #7fffd4;
- background: transparent; }

0 comments on commit 6196f20

Please sign in to comment.
Something went wrong with that request. Please try again.