[DRE-commits] [SCM] ruby-mocha.git branch, master, updated. debian/0.10.3-1-10-gaa00db7
Cédric Boutillier
cedric.boutillier at gmail.com
Sun Apr 22 10:01:21 UTC 2012
The following commit has been merged in the master branch:
commit 440111e36a900be5ed1e8d4a27493795813e742e
Author: Cédric Boutillier <cedric.boutillier at gmail.com>
Date: Sun Apr 22 02:40:22 2012 +0200
mention in README.source how to regenerate the documentation
diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..f932d7d
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,8 @@
+The documentation provided in the ruby-mocha-doc package is shipped with the
+upstream gem file. It is automatically generated from the source files. In
+order to regenerate it, you can call
+
+ rake -f debian/generate-doc.rake
+
+from the root of the source package. The Rakefile mentionned above is adapted
+from the upstream Rakefile. It requires the following packages: rake, yard
diff --git a/debian/generate-doc.rake b/debian/generate-doc.rake
new file mode 100644
index 0000000..a471853
--- /dev/null
+++ b/debian/generate-doc.rake
@@ -0,0 +1,35 @@
+require 'yard'
+require './lib/mocha/version'
+
+desc 'Remove generated documentation'
+task 'clobber_yardoc' do
+ `rm -rf ./doc`
+end
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new('yardoc') do |task|
+ task.options = ["--title", "Mocha #{Mocha::VERSION}", "--no-private"]
+ task.files = [
+ 'lib/mocha/api.rb',
+ 'lib/mocha/mock.rb',
+ 'lib/mocha/expectation.rb',
+ 'lib/mocha/object.rb',
+ 'lib/mocha/parameter_matchers.rb',
+ 'lib/mocha/parameter_matchers',
+ 'lib/mocha/state_machine.rb',
+ 'lib/mocha/sequence.rb',
+ 'lib/mocha/configuration.rb',
+ 'lib/mocha/stubbing_error.rb',
+ 'lib/mocha/unexpected_invocation.rb',
+ '-',
+ 'RELEASE.rdoc',
+ 'COPYING.rdoc',
+ 'MIT-LICENSE.rdoc',
+ 'examples/mocha.rb',
+ 'examples/stubba.rb',
+ 'examples/misc.rb',
+ ]
+end
+
+desc "Generate documentation"
+task 'default' => ['clobber_yardoc', 'yardoc']
diff --git a/debian/ruby-mocha-doc.docs b/debian/ruby-mocha-doc.docs
index 8e695ec..cc03ec5 100644
--- a/debian/ruby-mocha-doc.docs
+++ b/debian/ruby-mocha-doc.docs
@@ -1 +1,2 @@
+debian/README.source
doc
--
ruby-mocha.git
More information about the Pkg-ruby-extras-commits
mailing list