Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Deprecate RDoc generation and use rubydoc.info instead

  • Loading branch information...
commit bd046ac6a71490cb8366a491ae378cce9c5d737a 1 parent 52db153
@luislavena luislavena authored
Showing with 5 additions and 61 deletions.
  1. +5 −5 README.rdoc
  2. +0 −15 tasks/rdoc.rake
  3. +0 −41 tasks/rdoc_publish.rake
View
10 README.rdoc
@@ -304,11 +304,11 @@ development of it! (and contributions too!)
You can find more information about rake-compiler:
-Blog: http://blog.mmediasys.com
-RubyForge: http://rubyforge.org/projects/rake-compiler
-GitHub: http://github.com/luislavena/rake-compiler
-Issues: http://github.com/luislavena/rake-compiler/issues
-Wiki: http://github.com/luislavena/rake-compiler/wiki
+* GitHub: https://github.com/luislavena/rake-compiler
+* Issues: https://github.com/luislavena/rake-compiler/issues
+* Blog: http://blog.mmediasys.com
+* Docs: http://rubydoc.info/gems/rake-compiler
+* Wiki: https://github.com/luislavena/rake-compiler/wiki
== Disclaimer
View
15 tasks/rdoc.rake
@@ -1,15 +0,0 @@
-begin
- require 'rdoc/task'
-rescue LoadError
- warn "RDoc 2.4.3+ gem is required, please install it (gem install rdoc)."
-end
-
-if defined?(RDoc) then
- DOC = RDoc::Task.new(:rdoc) do |rd|
- rd.title = 'rake-compiler -- Documentation'
- rd.main = 'README.rdoc'
- rd.rdoc_dir = 'doc/api'
- rd.options << '--line-numbers' << '--main' << 'README.rdoc' << '--title' << 'rake-compiler -- Documentation'
- rd.rdoc_files.include %w(README.rdoc LICENSE.txt History.txt lib/**/*.rb)
- end
-end
View
41 tasks/rdoc_publish.rake
@@ -1,41 +0,0 @@
-begin
- require 'rubyforge'
-rescue LoadError
- warn "rubyforge gem is required to generate releases, please install it (gem install rubyforge)."
-end
-
-if defined?(RubyForge) then
- if defined?(DOC) && defined?(GEM_SPEC) then
- desc "Publish RDoc to RubyForge"
- task :publish => [:clobber_rdoc, :rdoc] do
- config_file = File.expand_path('~/.rubyforge/user-config.yml')
- fail "You need rubyforge properly configured." unless File.exist?(config_file)
-
- # no rubyforge project? no release for you!
- if GEM_SPEC.rubyforge_project == 'TODO' or GEM_SPEC.rubyforge_project.nil? then
- fail "Must define rubyforge_project in your gem specification."
- end
-
- # use YAML to load configuration file
- config = YAML.load_file(config_file)
-
- host = "#{config['username']}@rubyforge.org"
- remote_dir = "/var/www/gforge-projects/#{GEM_SPEC.rubyforge_project}/"
- local_dir = DOC.rdoc_dir
-
- # use PuTTY pscp or scp on other platforms
- ssh_exe = RUBY_PLATFORM =~ /mswin|mingw/ ? 'pscp' : 'scp'
-
- # construct the command
- cmd = [ssh_exe]
- cmd << '-r' << '-q' # recursive and quiet options
- cmd << "#{local_dir}/*"
- cmd << "#{host}:#{remote_dir}"
-
- puts "Publishing RDocs to RubyForge..."
- sh cmd.join(' ')
- end
- else
- warn "You need a GEM_SPEC and DOC rdoc definitions present. task publish not defined."
- end
-end
Please sign in to comment.
Something went wrong with that request. Please try again.