Generate docs using YARD

.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--protected
+--readme README.md
+--files lib/**/*.rb
+--markup markdown
+--hide-tag return
+--hide-tag param
+-e ./doc_config/yard/setup.rb

Gemfile

@@ -12,6 +12,12 @@ gem 'rails', '~> 3.0'
 gem 'rake', '>= 0.9.2'
 gem 'rspec-rails', '>= 2.13.1', '< 3'
 
+# YARD
+gem 'yard'
+gem 'redcarpet'
+gem 'pygments.rb'
+gem 'watchr'
+
 # For test Rails application
 gem 'shoulda-context', '~> 1.2.0'
 gem 'sqlite3', :platform => :ruby

Gemfile.lock

@@ -75,10 +75,14 @@ GEM
     multi_json (1.8.4)
     multi_test (0.0.3)
     polyglot (0.3.3)
+    posix-spawn (0.3.8)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pygments.rb (0.3.7)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
     rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
@@ -104,6 +108,7 @@ GEM
     rake (10.1.1)
     rdoc (3.12.2)
       json (~> 1.4)
+    redcarpet (3.0.0)
     rspec-core (2.14.7)
     rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
@@ -130,6 +135,9 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.38)
+    watchr (0.7)
+    yajl-ruby (1.1.0)
+    yard (0.8.7.3)
 
 PLATFORMS
   ruby
@@ -145,10 +153,14 @@ DEPENDENCIES
   jdbc-sqlite3
   jruby-openssl
   pry
+  pygments.rb
   rails (~> 3.0)
   rake (>= 0.9.2)
+  redcarpet
   rspec-rails (>= 2.13.1, < 3)
   shoulda-context (~> 1.2.0)
   shoulda-matchers!
   sqlite3
   therubyrhino
+  watchr
+  yard

README.md

@@ -131,6 +131,21 @@ gem 'shoulda-matchers'
 gem 'activemodel'
 ```
 
+## Generating documentation
+
+YARD is used to generate documentation, which can be viewed online at
+<http://thoughtbot.github.com/shoulda-matchers>. You can preview changes you
+make to the documentation locally by running
+
+    yard doc
+
+from this directory. Then, open `doc/index.html` in your browser.
+
+If you want to see a live preview as you work without having to run `yard` over
+and over again, keep this command running in a separate terminal session:
+
+    watchr yard.watchr
+
 ## Versioning
 
 shoulda-matchers follows Semantic Versioning 2.0 as defined at

doc_config/yard/setup.rb

@@ -0,0 +1,22 @@
+YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/templates')
+
+require 'pygments.rb'
+
+module YARD
+  module Templates
+    module Helpers
+      module HtmlSyntaxHighlightHelper
+        def html_syntax_highlight_ruby(source)
+          highlight_with_pygments(:ruby, source)
+        end
+
+        private
+
+        def highlight_with_pygments(language, source)
+          html = Pygments.highlight(source, lexer: language.to_s)
+          html.sub(%r{\A<div class="highlight">\s*<pre>}, '').sub(%r{</pre>\s*</div>\Z}, '')
+        end
+      end
+    end
+  end
+end