rokko 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -21,6 +21,10 @@ Install with Rubygems:
21
21
 
22
22
  sudo gem install rokko
23
23
 
24
+ or Bundler:
25
+
26
+ gem 'rokko'
27
+
24
28
  ##Usage
25
29
 
26
30
  `rokko` command can be used to generate documentation for a set of Ruby source files:
data/lib/rokko/layout.rb CHANGED
@@ -1,4 +1,5 @@
1
1
  require 'pathname'
2
+
2
3
  module Rokko
3
4
  class Layout < Mustache
4
5
  self.template_path = File.dirname(__FILE__)
@@ -19,8 +20,8 @@ module Rokko
19
20
 
20
21
  "<style type=\"text/css\" media=\"screen, projection\">#{docco}\n#{highlight}</style>"
21
22
  else
22
- "<link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/v#{::Rokko::VERSION}/assets/docco.css\" />
23
- <link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/v#{::Rokko::VERSION}/assets/highlight.css\" />"
23
+ "<link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/docco.css\" />
24
+ <link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/highlight.css\" />"
24
25
  end
25
26
  end
26
27
 
@@ -28,7 +29,7 @@ module Rokko
28
29
  js = if @options[:local]
29
30
  "<script>#{File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.pack.js'))}</script>"
30
31
  else
31
- "<script src=\"http://vast.github.com/rokko/v#{::Rokko::VERSION}/assets/highlight.pack.js\"></script>"
32
+ "<script src=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/highlight.pack.js\"></script>"
32
33
  end
33
34
 
34
35
  js + "\n" + "<script>hljs.initHighlightingOnLoad();</script>\n"
data/lib/rokko/task.rb CHANGED
@@ -1,3 +1,17 @@
1
+ # Usage:
2
+ #
3
+ # Rokko::Task.new(:task_name, output_dir, filelist, opts)
4
+ #
5
+ # Example:
6
+ # Rokko::Task.new(:rokko, 'docs',
7
+ # ['lib/**/*.rb', 'README.md'],
8
+ # {:index => true, :local => true})
9
+ #
10
+ # Available options:
11
+ #
12
+ # * `:local` -- generate offline-ready documentation.
13
+ # * `:index` -- if value is a file name, then it will be used as an index. If value is `true` then
14
+ # an index file with table of contents will be generated.
1
15
  require 'rokko'
2
16
 
3
17
  module Rokko
data/lib/rokko/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Rokko
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.2"
3
3
  end
metadata CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
5
5
  segments:
6
6
  - 0
7
7
  - 1
8
- - 1
9
- version: 0.1.1
8
+ - 2
9
+ version: 0.1.2
10
10
  platform: ruby
11
11
  authors:
12
12
  - Vasily Polovnyov