Skip to content

Commit

Permalink
upgrade SDoc
Browse files Browse the repository at this point in the history
Kudos to @zzak for taking over SDoc and make it work with RDoc 4.
  • Loading branch information
fxn committed Jan 12, 2014
1 parent 20a795f commit 6049249
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Expand Up @@ -18,7 +18,7 @@ gem 'coffee-rails', '~> 4.0.0'
gem 'uglifier', '>= 1.3.0', require: false

group :doc do
gem 'sdoc'
gem 'sdoc', '~> 0.4.0'
gem 'redcarpet', '~> 2.2.2', platforms: :ruby
gem 'w3c_validators'
gem 'kindlerb'
Expand Down
6 changes: 2 additions & 4 deletions guides/code/getting_started/Gemfile
Expand Up @@ -22,10 +22,8 @@ gem 'jquery-rails'
# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
gem 'turbolinks'

group :doc do
# bundle exec rake doc:rails generates the API under doc/api.
gem 'sdoc', require: false
end
# bundle exec rake doc:rails generates the API under doc/api.
gem 'sdoc', '~> 0.4.0', group: :doc

# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
gem 'jbuilder', '~> 2.0'
Expand Down
8 changes: 4 additions & 4 deletions guides/code/getting_started/Gemfile.lock
Expand Up @@ -71,16 +71,16 @@ GEM
rake (>= 0.8.7)
thor (>= 0.18.1, < 2.0)
rake (10.1.0)
rdoc (3.12.2)
rdoc (0.4.0)
json (~> 1.4)
sass (3.2.9)
sass-rails (4.0.0)
railties (>= 4.0.0.beta, < 5.0)
sass (>= 3.1.10)
sprockets-rails (~> 2.0.0)
sdoc (0.3.20)
json (>= 1.1.3)
rdoc (~> 3.10)
sdoc (0.4.0)
json (~> 1.8)
rdoc (~> 4.0, < 5.0)
sprockets (2.10.0)
hike (~> 1.2)
multi_json (~> 1.0)
Expand Down
4 changes: 4 additions & 0 deletions railties/CHANGELOG.md
@@ -1,3 +1,7 @@
* The `Gemfile` of new applications depends on SDoc ~> 0.4.0.

*Xavier Noria*

* `test_help.rb` now automatically checks/maintains your test datbase
schema. (Use `config.active_record.maintain_test_schema = false` to
disable.)
Expand Down
2 changes: 1 addition & 1 deletion railties/lib/rails/generators/app_base.rb
Expand Up @@ -352,7 +352,7 @@ def jbuilder_gemfile_entry

def sdoc_gemfile_entry
comment = 'bundle exec rake doc:rails generates the API under doc/api.'
GemfileEntry.new('sdoc', nil, comment, { group: :doc, require: false })
GemfileEntry.new('sdoc', '~> 0.4.0', comment, group: :doc)
end

def coffee_gemfile_entry
Expand Down
4 changes: 2 additions & 2 deletions railties/test/generators/app_generator_test.rb
Expand Up @@ -390,9 +390,9 @@ def test_inclusion_of_debugger
end
end

def test_inclusion_of_lazy_loaded_sdoc
def test_inclusion_of_doc
run_generator
assert_file 'Gemfile', /gem 'sdoc', \s+group: :doc, require: false/
assert_file 'Gemfile', /gem 'sdoc',\s+'~> 0.4.0',\s+group: :doc/
end

def test_template_from_dir_pwd
Expand Down

3 comments on commit 6049249

@zzak
Copy link
Member

@zzak zzak commented on 6049249 Jan 13, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙇 Thank you @fxn!

@fxposter
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's interesting that rdoc's version is '0.4.0' in Gemfile.lock

@fxn
Copy link
Member Author

@fxn fxn commented on 6049249 Jan 13, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's wrong, I'll fix it.

Please sign in to comment.