Skip to content
Browse files

add a rake doc task

  • Loading branch information...
1 parent 9c9bf3e commit 49d18f86f15ba64e85a47a43277e408eeb5f100e @lkdjiin committed Feb 26, 2011
Showing with 18 additions and 3 deletions.
  1. +2 −0 .gitignore
  2. +7 −1 README.rdoc
  3. +5 −0 Rakefile
  4. +4 −2 TODO
View
2 .gitignore
@@ -1,3 +1,5 @@
*.gem
coverage/
.coco
+.yardoc/
+doc/
View
8 README.rdoc
@@ -12,13 +12,19 @@ This one suits my needs.
* Configuration could be done via a simple yaml file
* Colorized console output (*nix only)
+<em>Note: I have tested coco only on debian linux. I have not tested it with the test/unit
+framework.</em>
+
== Documentation
require 'coco'
at the beginning of your tests, usually in a \*helper\*.rb file.
-See {the wiki}[https://github.com/lkdjiin/coco/wiki] for more information.
+See {the wiki}[https://github.com/lkdjiin/coco/wiki] for more information on using coco.
+
+To generate the developper's documentation in YARD format:
+ rake doc
== Dependencies
View
5 Rakefile
@@ -25,3 +25,8 @@ task :install do
f = FileList['coco*gem'].to_a
sh "gem install #{f.first} --no-rdoc --no-ri"
end
+
+desc 'Generate yard documentation for developpers'
+task :doc do
+ exec 'yardoc --title "Coco Documentation" - NEWS COPYING VERSION'
+end
View
6 TODO
@@ -15,5 +15,7 @@ Je voudrais qu'il ouvre le navigateur tout seul (que ce soit une option).
ok* option to exclude files from the coverage
ok* add colors to console output (*nix only)
-* readme: tested only with debian and rspec
-* doc task, yard
+ok* readme: tested only with debian and rspec
+ok* doc task, yard
+* news
+* rubygem

0 comments on commit 49d18f8

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