Skip to content
This repository has been archived by the owner on Jun 4, 2021. It is now read-only.

Commit

Permalink
Add yardoc support, using GitHub Format Markdown
Browse files Browse the repository at this point in the history
This adds yardoc support to the gemfile, in a group, and configuration to make
it default to GitHub Format Markdown -- for compatibility with the most common
place for our output to be rendered and read.

Signed-off-by: Daniel Pittman <[email protected]>
  • Loading branch information
slippycheeze committed Jun 18, 2013
1 parent 591774a commit 24f035e
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 12 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
config.yaml
log/*
/.yardoc
2 changes: 2 additions & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--markup-provider=redcarpet
--markup=markdown
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ gem 'sinatra'
gem 'pg'
gem 'sequel'

group :doc do
gem 'yard'
gem 'redcarpet'
gem 'github-markup'
end

group :test do
gem 'rack-test'
gem 'rspec'
Expand Down
30 changes: 18 additions & 12 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
GEM
remote: https://rubygems.org/
specs:
diff-lcs (1.1.3)
pg (0.14.1)
diff-lcs (1.2.4)
github-markup (0.7.5)
pg (0.15.1)
rack (1.5.2)
rack-protection (1.5.0)
rack
rack-test (0.6.2)
rack (>= 1.0)
rspec (2.12.0)
rspec-core (~> 2.12.0)
rspec-expectations (~> 2.12.0)
rspec-mocks (~> 2.12.0)
rspec-core (2.12.2)
rspec-expectations (2.12.1)
diff-lcs (~> 1.1.3)
rspec-mocks (2.12.2)
redcarpet (2.3.0)
rspec (2.13.0)
rspec-core (~> 2.13.0)
rspec-expectations (~> 2.13.0)
rspec-mocks (~> 2.13.0)
rspec-core (2.13.1)
rspec-expectations (2.13.0)
diff-lcs (>= 1.1.3, < 2.0)
rspec-mocks (2.13.1)
sequel (3.48.0)
sinatra (1.4.2)
rack (~> 1.5, >= 1.5.2)
sinatra (1.4.3)
rack (~> 1.4)
rack-protection (~> 1.4)
tilt (~> 1.3, >= 1.3.4)
tilt (1.4.1)
yard (0.8.6.1)

PLATFORMS
ruby

DEPENDENCIES
github-markup
pg
rack-test
redcarpet
rspec
sequel
sinatra
yard

0 comments on commit 24f035e

Please sign in to comment.