sdoc 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29716368d7c072908ecc4b13c04570fe435166e6
-  data.tar.gz: 706d48301caebca63b188da2033a7dee963bfaa8
+SHA256:
+  metadata.gz: 19f36e49016466f31b053d9a66c757e33998e7023ddad39f2d86f46834fd4784
+  data.tar.gz: 36b2ca06033e0caecb8b5bbcf61210a5bd7139b1f66919b112c1af738fa3d0b0
 SHA512:
-  metadata.gz: 94539d716999ecf5b07ba5b93a2974e5fdc22b8f231449195c70129a74856e4ce9ef68bfff8d80ded0bcf4852b14be66110510fa62a7a4200dc04620f3ce0203
-  data.tar.gz: 42a050c73aa5ab6fc403d3b4f37fd66261b9edb78b974ec2bf2b76289f9734e3ce8b4e8a348a0d6e0743b89ff924dcf571cddf1a078ddbe051fc5f310eb90abc
+  metadata.gz: 837f60a6d4880c4fa5e1000c5216377a1827aab83f0ec2ecffccd903533215a3b4a972beec2a2ec0c3a9332bde5d05477f3c066da950d8eda3776f41f950f5fc
+  data.tar.gz: 965695dcc2e8e9c2e8ea1a608be79549767a719f607721f3364a72b5b5398c48ccd6f9d19d992954565fcf40b9d31922083a98e30760ad628b1558e1315c5e57

data/.travis.yml

@@ -1,15 +1,16 @@
 language: ruby
 cache: bundler
 before_install:
+  - gem update --system
   - gem install bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.2.9
-  - 2.3.6
-  - 2.4.2
-  - 2.5.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
   - ruby-head
   - jruby-head
 matrix:
@@ -17,10 +18,10 @@ matrix:
     - env: rdoc=master
     - rvm: jruby-head
   include:
-    - { rvm: 2.2.9, env: rdoc=master }
-    - { rvm: 2.3.6, env: rdoc=master }
-    - { rvm: 2.4.2, env: rdoc=master }
-    - { rvm: 2.5.0, env: rdoc=master }
+    - { rvm: 2.2.10, env: rdoc=master }
+    - { rvm: 2.3.7, env: rdoc=master }
+    - { rvm: 2.4.4, env: rdoc=master }
+    - { rvm: 2.5.1, env: rdoc=master }
     - { rvm: ruby-head, env: rdoc=master }
     - { rvm: jruby-head, env: rdoc=master }
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+1.1.0
+=====
+
+* #138 - Fix panel header overflow on Chrome
+* 39e6cae9 - Display version using `-v` or `--version` flags
+
+1.0.0
+=====
+
+* #110 - Strip out HTML tags from search results description
+* #109 - Add basic SEO tags
+* #108 - Tiny refresh of the Rails theme
+* e6f02b91 - Remove the jQuery effect library
+* 73ace366 - Remove the `--without-search` option
+* b1d429f2 - Produce HTML 5 output
+* 38d06095 - Support only RDoc 5 and up
+* #96 - Require at least Ruby 1.9.3
+
 0.4.2
 =====
 

data/README.md

@@ -1,6 +1,6 @@
 # SDoc
 
-[![Build Status](https://travis-ci.org/zzak/sdoc.png?branch=master)](https://travis-ci.org/zzak/sdoc)
+[![Build Status](https://travis-ci.org/zzak/sdoc.svg?branch=master)](https://travis-ci.org/zzak/sdoc)
 
 **Powering http://api.rubyonrails.org/**
 
@@ -62,9 +62,9 @@ require 'sdoc' # and use your RDoc task the same way you used it before
 require 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`
 
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc' # name of output directory
-  rdoc.generator = 'sdoc' # explictly set the sdoc generator
-  rdoc.template = 'rails' # template used on api.rubyonrails.org
+  rdoc.rdoc_dir = 'doc/rdoc'      # name of output directory
+  rdoc.options << '--format=sdoc' # explictly set the sdoc generator
+  rdoc.template = 'rails'         # template used on api.rubyonrails.org
 end
 ```
 
@@ -78,7 +78,7 @@ Alternatively you can pass this command a path to the project you wish to compil
 
 As mentioned before, SDoc is built on top of the RDoc project.
 
-If you notice any bugs in the output of your documentation, it may be RDoc's fault and should be [reported upstream](https://github.com/rdoc/rdoc/issues/new).
+If you notice any bugs in the output of your documentation, it may be RDoc's fault and should be [reported upstream](https://github.com/ruby/rdoc/issues/new).
 
 An example of an SDoc bug would be:
 

data/bin/sdoc

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -KU
+#!/usr/bin/env ruby
 require 'sdoc'
 
 begin

data/bin/sdoc-merge

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -KU
+#!/usr/bin/env ruby
 require File.dirname(__FILE__) + '/../lib/sdoc' # add extensions
 require 'sdoc/merge'
 

data/lib/rdoc/discover.rb

@@ -1,5 +1,5 @@
 begin
-  gem 'rdoc', '~> 5.0'
+  gem 'rdoc', '>= 5.0'
   require File.join(File.dirname(__FILE__), '/../sdoc')
 rescue Gem::LoadError
 end

data/lib/rdoc/generator/template/rails/resources/css/panel.css

@@ -29,6 +29,7 @@
             position: absolute;
             left: 0; top: 0;
             z-index: 300;
+            overflow: hidden;
         }
 
         .panel .header input

data/lib/sdoc/generator.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'sdoc/github'
 require 'sdoc/templatable'
 require 'sdoc/helpers'
+require 'sdoc/version'
 require 'rdoc'
 
 class RDoc::ClassModule
@@ -59,6 +60,10 @@ class RDoc::Generator::SDoc
     end
     opt.separator nil
 
+    opt.on("--version", "-v", "Output current version") do
+      puts SDoc::VERSION
+      exit
+    end
   end
 
   def initialize(store, options)

data/lib/sdoc/version.rb

@@ -1,3 +1,3 @@
 module SDoc
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/rdoc_generator_spec.rb

@@ -37,4 +37,12 @@ describe RDoc::Generator::SDoc do
     err.wont_match(/^invalid options/)
     @options.github.must_equal true
   end
+
+  it "should display SDoc version on -v or --version" do
+    out_full  = `./bin/sdoc --version`
+    out_short = `./bin/sdoc -v`
+
+    out_short.strip.must_equal SDoc::VERSION
+    out_full.strip.must_equal SDoc::VERSION
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Kolesnikov
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -119,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: rdoc html with javascript search index.