Yard::Serverspec::Plugin
This plugin adds Serverspec specs to YARD output.
Installation
Add this line to your application's Gemfile:
gem 'yard-serverspec-plugin'And then execute:
$ bundle
Or install it yourself as:
$ gem install yard-serverspec-plugin
Usage
Add comments to your specs.
# @param kernel.panic Kernel behaviour on panic: delay
# @note default: 0 (wait forever). Check 30 seconds before rebooting.
context linux_kernel_parameter('kernel.panic') do
its(:value) { should <= 30 }
end
You're ready to go:
yardoc -e yard-serverspec spec/*_spec.rb
or You can do this by adding the following to your Rakefile:
namespace :doc do
begin
require 'yard'
require 'yard/rake/yardoc_task'
require 'yard/serverspec/plugin'
rescue LoadError
raise 'YARD is not available. Try installing it.'
end
YARD::Config.load_plugin('serverspec-plugin')
YARD::Rake::YardocTask.new do |t|
t.files = ['spec/*_spec.rb']
end
end
and type:
rake doc:yard
then, you can see doc:
Contributing
- Fork it ( https://github.com/rrreeeyyy/yard-serverspec-plugin/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request