sdoc 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f126dd289aad3c1e79f289d9895309baf90987
-  data.tar.gz: 50bb0ed83c4ac2ae0041f41aabbbf633573dec8a
+  metadata.gz: 03c6caeefa3e802c77599a6805c6926965d0155f
+  data.tar.gz: 2a2840f5bb0358ee7846b6f0d18516d8f3a37878
 SHA512:
-  metadata.gz: ad3c54ed2f52a415fb4f766d88fcebd69bf3ef457ff7bdfcd7ab960af0ec424bec276efb6151c922fa08c7912c3568f599a074735fffb8d85fa060cb0b544766
-  data.tar.gz: 449c768107dc9bedc0ce1257d594ed3085f0613609ecda6c7bbe9a2cd6fa2c50d035e0579806f747fb34dd583c9d69b325c5fdcab8eaa8644d957a65006c182a
+  metadata.gz: 1ad4baba8991f43259a81adcde968a8eb33d8f951519b2a670b4d27d4927f8dda46b9ab5ded2d980f4243025b4499005984f0cbedb978e68eb6ece52b4bf58a4
+  data.tar.gz: eb4e49914ebd0863b919657ec319ed1f238ad261b249dbf2966c0371d5544725718f408b5184cbee32d367d2772e8c01030234da42526034d24bb496c11a15ef

data/.travis.yml

@@ -1,12 +1,29 @@
 ---
+before_install:
+  - gem install bundler
 rvm:
   - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
+  - 2.3.0
   - ruby-head
   - jruby-19mode
   - jruby-head
+matrix:
+  allow_failures:
+    - env: rdoc=master
+  include:
+    - { rvm: 1.8.7, env: rdoc=master }
+    - { rvm: 1.9.3, env: rdoc=master }
+    - { rvm: 2.0.0, env: rdoc=master }
+    - { rvm: 2.1.0, env: rdoc=master }
+    - { rvm: 2.2.0, env: rdoc=master }
+    - { rvm: 2.3.0, env: rdoc=master }
+    - { rvm: ruby-head, env: rdoc=master }
+    - { rvm: jruby-19mode, env: rdoc=master }
+    - { rvm: jruby-head, env: rdoc=master }
 notifications:
-  recipients:
-    - zachary@zacharyscott.net
+  email:
+    - mail@zzak.io

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+0.4.2
+=====
+
+[Compare v0.4.1...v0.4.2](https://github.com/voloko/sdoc/compare/v0.4.1...v0.4.2)
+
+0.4.1
+=====
+
+[Compare v0.4.0...v0.4.1](https://github.com/voloko/sdoc/compare/v0.4.0...v0.4.1)
+
+Breaking Changes
+----------------
+
+None.
+
+Enhancements
+------------
+
+- 65e46cb2 Unordered lists inside ordered ones render ordered
+- SDoc::VERSION
+  - 2fe1a7b8 Move version to separate file, remove require_relative from gemspec
+  - 97e1eda8 Push ./lib to $LOAD_PATH for require SDoc::VERSION
+  - ad0a7e1e Initialize SDoc namespace in main file
+
+Bug Fixes
+---------
+
+- 926ff732 Remove redundany < 5.0 from rdoc dependency specification
+- db99e402 Remove code tags styling under pre elements
+- a1d7e211 Follow up of #68
+- bffc93ef Relax JSON dependency to ~> 1.7, >= 1.7.7
+- 404dceb9 GH-72: Extra `<p>` tags appear in results snippet
+
+0.4.0
+=====
+
+[Compare v0.3.20...v0.4.0](https://github.com/voloko/sdoc/compare/v0.3.20...v0.4.0)
+
+No friendly log for this version yet, but PRs are welcome!
+

data/Gemfile

@@ -1,3 +1,11 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "rake", "< 11"
+gem "minitest"
+gem "hoe"
+
+if ENV["rdoc"] == "master"
+  gem "rdoc", :github => "rdoc/rdoc"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Vladimir Kolesnikov
+Copyright (c) 2014 Zachary Scott, Vladimir Kolesnikov, and Nathan Broadbent
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -107,4 +107,4 @@ version 2 (see the file GPL), or the conditions below:
   6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.
+     PURPOSE.

data/README.md

@@ -2,30 +2,32 @@
 
 [![Build Status](https://travis-ci.org/zzak/sdoc.png?branch=master)](https://travis-ci.org/zzak/sdoc)
 
-**Powering http://api.rubyonrails.org/ and http://railsapi.com/**
+**Powering http://api.rubyonrails.org/**
 
 ### What is sdoc?
 
-RDoc generator to build searchable HTML documentation for Ruby code.
+SDoc is an HTML template built on top of the RDoc documentation generator for Ruby code.
+
+Provided are two command-line tools you get when you installing the gem:
 
 * `sdoc` - command line tool to run rdoc with `generator=shtml` (searchable HTML)
 * `sdoc-merge` - command line tool to merge multiple sdoc folders into a single documentation site
 
-
 ### Getting Started
 
 ```bash
-  # Install the gem
-  gem install sdoc
+# Install the gem
+gem install sdoc
 
-  # Generate documentation for 'projectdir'
-  sdoc projectdir
+# Generate documentation for 'projectdir'
+sdoc projectdir
 ```
 
 ### sdoc
 
-`sdoc` is simply a wrapper for the `rdoc` command line tool. See `sdoc --help`
-for more details. `--fmt` is set to `shtml` by default. The default template `-T` is `shtml`, but you can also use the `direct` template.
+`sdoc` is simply a wrapper for the `rdoc` command line tool. See `sdoc --help` for more details.
+
+When using the `sdoc` command, `--fmt` is set to `shtml` by default. The default template (or `-T` option) is set to `shtml`, but you can also use the `direct` template when generating documentation.
 
 Example:
 
@@ -35,12 +37,14 @@ sdoc -o doc/rails -T direct rails
 
 ### sdoc-merge
 
-<pre>
+`sdoc-merge` is useful tool for combining multiple projects documentation into one HTML website. See `sdoc-merge --help` for more details.
+
+```
 Usage: sdoc-merge [options] directories
     -n, --names [NAMES]              Names of merged repositories. Comma separated
     -o, --op [DIRECTORY]             Set the output directory
     -t, --title [TITLE]              Set the title of merged file
-</pre>
+```
 
 Example:
 
@@ -50,19 +54,44 @@ sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails"
 
 ### Rake Task
 
+If you want, you can setup a task in your `Rakefile` for generating your project's documentation via the `rake rdoc` command.
+
 ```ruby
 # Rakefile
 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`
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
-  rdoc.template = 'direct' # lighter template used on railsapi.com
-  ...
+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
 end
 ```
 
-# Who?
+NOTE: If you don't set `template` the default "sdoc" template is chosen, with a lighter color scheme.
+
+Now you can execute this command with `rake rdoc`, to compile the documentation for the current project directory.
+
+Alternatively you can pass this command a path to the project you wish to compile: `rake rdoc path/to/project`.
+
+### RDoc
+
+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).
+
+An example of an SDoc bug would be:
+
+* Exception is raised when merging project documentation (ala `sdoc-merge`)
+* Error or warning in JavaScript or HTML found in your browser
+* Generation fails with some exception (likely due to incompatibility with RDoc)
+
+Please feel free to still report issues here for both projects, especially if you aren't sure.
+
+As maintainer of both projects, I'll see if I can identify the root of the cause :bow: :bow: :bow:
+
+
+### Who?
 
 * Vladimir Kolesnikov ([voloko](https://github.com/voloko))
 * Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))

data/Rakefile

@@ -11,3 +11,24 @@ end
 
 task :default => :test
 task :spec => :test
+
+require 'sdoc'
+require 'rdoc/task'
+
+rails = File.expand_path "rails"
+
+directory rails do
+  sh "git clone --depth=1 https://github.com/rails/rails"
+end
+
+namespace :test do
+  task :rails => rails
+
+  RDoc::Task.new(:rails) do |rdoc|
+    rdoc.rdoc_dir = 'doc/rails'
+    rdoc.generator = 'sdoc'
+    rdoc.template = 'rails'
+
+    rdoc.rdoc_files.include("rails/")
+  end
+end

data/lib/rdoc/generator/template/merge/index.rhtml

@@ -1,11 +1,11 @@
 <!DOCTYPE html
      PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">    
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
 
-	<title><%= @title %></title>
+  <title><%= @title %></title>
 </head>
 <frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
     <frame src="panel/index.html" title="Search" name="panel" />

data/lib/rdoc/generator/template/sdoc/_context.rhtml

@@ -150,19 +150,19 @@
         <div class="method">
           <div class="title method-title" id="<%= method.aref %>">
             <% if method.call_seq %>
-              <b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;').gsub(/\n(.)/, '<br />\1') %></b>
             <% else %>
               <b><%= h method.name %></b><%= h method.params %>
             <% end %>
             <a href="<%= "#{rel_prefix}/#{context.path}##{method.aref}"%>" name="<%= method.aref %>" class="permalink">Link</a>
           </div>
-          
+
           <% if method.comment %>
             <div class="description">
               <%= method.description.strip %>
             </div>
           <% end %>
-          
+
           <% unless method.aliases.empty? %>
             <div class="aka">
               Also aliased as: <%= method.aliases.map do |aka|
@@ -180,7 +180,7 @@
               Alias for: <a href="<%= context.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
             </div>
           <% end %>
-          
+
           <% if method.token_stream %>
             <% markup = method.sdoc_markup_code %>
             <div class="sourcecode">
@@ -197,7 +197,7 @@
                 end
               %>
               <p class="source-link">
-                Source: 
+                Source:
                 <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
                 <% if github %>
                   | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>

data/lib/rdoc/generator/template/sdoc/class.rhtml

@@ -8,16 +8,16 @@
     <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
 </head>
 
-<body>     
+<body>
     <div class="banner">
         <% if ENV['HORO_PROJECT_NAME'] %>
             <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
         <% end %>
         <h1>
-            <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span> 
-            <%= h klass.full_name %> 
+            <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span>
+            <%= h klass.full_name %>
             <% if klass.type == 'class' %>
-                <span class="parent">&lt; 
+                <span class="parent">&lt;
                     <% if String === klass.superclass %>
                     <%= klass.superclass %>
                     <% elsif !klass.superclass.nil? %>
@@ -36,4 +36,4 @@
         <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
     </div>
   </body>
-</html>    
+</html>

data/lib/rdoc/generator/template/sdoc/file.rhtml

@@ -8,7 +8,7 @@
     <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
 </head>
 
-<body>     
+<body>
     <div class="banner">
         <% if ENV['HORO_PROJECT_NAME'] %>
             <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />

data/lib/rdoc/generator/template/sdoc/index.rhtml

@@ -1,6 +1,6 @@
 <!DOCTYPE html
      PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">    
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />

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

@@ -12,8 +12,8 @@
         //zoom: 1;
     }
     
-    .panel_tree .results, 
-    .panel_results .tree 
+    .panel_tree .results,
+    .panel_results .tree
     {
         display: none;
     }
@@ -68,8 +68,16 @@
         }
         
     /* Header with search box (end) */
-    
-        
+
+    /* Results and tree (begin) */
+        .panel .result ul li a,
+        .panel .tree   ul li a
+        {
+            display: block;
+            text-decoration: none;
+        }
+    /* Results and tree (end) */
+
     /* Results (begin) */
         .panel .result
         {
@@ -97,23 +105,19 @@
 
         .panel .result ul li
         {
-            height: 46px;
-            -height: 50px;
-            //display: inline;
-            //width: 100%;
-            //zoom: 1;
             overflow: hidden;
             padding: 4px 10px 0 10px;
             cursor: pointer;
+            height: 46px;
         }
 
-        .panel .result ul li h1
+        .panel .result ul li a
         {
             font-size: 13px;
             font-weight: normal;
             color: #333;
-            margin-bottom: 2px;
             white-space: nowrap;
+            margin-bottom: 2px;
         }
 
         .panel .result ul li p
@@ -124,7 +128,7 @@
             white-space: nowrap;
         }
 
-        .panel .result ul li h1 i,
+        .panel .result ul li a i,
         .panel .result ul li p.snippet
         {
             color: #999;
@@ -140,13 +144,13 @@
             background: #3875D7;
         }
 
-        .panel .result ul li.current h1,
+        .panel .result ul li.current a,
         .panel .result ul li.current p
         {
             color: #DDD;
         }
 
-        .panel .result ul li.current h1 i,
+        .panel .result ul li.current a i,
         .panel .result ul li.current p.snippet
         {
             color: #AAA;
@@ -260,29 +264,25 @@
         .panel .tree ul
         {
             background: #EDF3FE url(../i/tree_bg.png);
-        }          
-        
-        .panel .tree li
+        }
+
+        .panel .tree ul li
         {
             cursor: pointer;
             overflow: hidden;
-            //height: 23px;
-            //display: inline;
-            //zoom: 1;
-            //width: 100%;
+            height: 23px;
+            line-height: 23px;
         }
-        
-        
-        .panel .tree li .content
+
+
+        .panel .tree ul li .content
         {
             padding-left: 18px;
-            padding-top: 5px;
-            height: 18px;
             overflow: hidden;
             position: relative;
         }
-        
-        .panel .tree li .icon
+
+        .panel .tree ul li .icon
         {
             width: 10px;
             height: 9px;
@@ -293,18 +293,17 @@
             top: 8px;
             cursor: default;
         }
-        
-        .panel .tree li.closed .icon
+
+        .panel .tree ul li.closed .icon
         {
             background-position: 0 0;
         }
-        
-        .panel .tree ul li h1
+
+        .panel .tree ul li a
         {
             font-size: 13px;
             font-weight: normal;
             color: #000;
-            margin-bottom: 2px;
             white-space: nowrap;
         }
 
@@ -315,8 +314,8 @@
             margin-bottom: 2px;
             white-space: nowrap;
         }
-        
-        .panel .tree ul li h1 i
+
+        .panel .tree ul li a i
         {
             color: #999;
             font-style: normal;
@@ -325,9 +324,9 @@
         .panel .tree ul li.empty
         {
             cursor: text;
-        }   
-        
-        .panel .tree ul li.empty h1,
+        }
+
+        .panel .tree ul li.empty a,
         .panel .tree ul li.empty p
         {
             color: #666;
@@ -349,7 +348,7 @@
             background-position: -10px 0;
         }
 
-        .panel .tree ul li.current h1
+        .panel .tree ul li.current a
         {
             color: #FFF;
         }
@@ -359,7 +358,7 @@
             color: #CCC;
         }
 
-        .panel .tree ul li.current.empty h1,
+        .panel .tree ul li.current.empty a,
         .panel .tree ul li.current.empty p
         {
             color: #999;