rokko 0.5.0 → 0.5.1
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.
- checksums.yaml +7 -0
- data/README.md +22 -16
- data/Rakefile +3 -1
- data/lib/rokko/version.rb +1 -1
- data/rokko.gemspec +3 -3
- metadata +28 -19
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b75f0709250dc4a74bbb464b3af9dd5f0ac5be54
|
4
|
+
data.tar.gz: 10ead24d22da159413481618943efcb2c833d529
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 42d4f1c4c3eb93478f8e8f72cba1a0cabd84991ab46865bf19f58026df4158daf2a7a3c41556ad9a9fee7c16da650db4b336365099cba0e44b7b50079e4c62b7
|
7
|
+
data.tar.gz: 2d71915dfdf676d2b1ebc4568985b482462d78fd207693fc0e332c1e74cc3b015f4f353dcf5da60dcca5244ae631b577c65ea7861e7144563a9476ef2b6f5cfa
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
Rokko
|
1
|
+
Rokko — fat-free [Rocco](http://rtomayko.github.com/rocco/)
|
2
2
|
=============================================================
|
3
3
|
|
4
4
|
Rokko is an else one Ruby port of [Docco](http://jashkenas.github.com/docco/),
|
@@ -23,7 +23,9 @@ Install with Rubygems:
|
|
23
23
|
|
24
24
|
or Bundler:
|
25
25
|
|
26
|
-
|
26
|
+
```ruby
|
27
|
+
gem 'rokko'
|
28
|
+
```
|
27
29
|
|
28
30
|
## Usage
|
29
31
|
|
@@ -33,11 +35,13 @@ or Bundler:
|
|
33
35
|
|
34
36
|
It is also possible to use Rokko as a Rake task:
|
35
37
|
|
36
|
-
|
38
|
+
```ruby
|
39
|
+
require 'rokko/task'
|
37
40
|
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
+
Rokko::Task.new(:rokko, 'docs', # task name, output directory
|
42
|
+
['lib/**/*.rb', 'README.md'],
|
43
|
+
{:index => true, :local => true})
|
44
|
+
```
|
41
45
|
|
42
46
|
And run:
|
43
47
|
|
@@ -45,22 +49,24 @@ And run:
|
|
45
49
|
|
46
50
|
## Options and configuration
|
47
51
|
|
48
|
-
* `-l`, `--local`
|
49
|
-
* `-i`, `--index`
|
50
|
-
* `-i <file>`, `--index=<file>`
|
51
|
-
* `-o`, `--output=<dir>`
|
52
|
-
* `-s`, `--stylesheet=<url>`
|
52
|
+
* `-l`, `--local` — generate offline-ready documentation.
|
53
|
+
* `-i`, `--index` — generate index.html with links (TOC) to all generated HTML files.
|
54
|
+
* `-i <file>`, `--index=<file>` — use `<file>` as index.html.
|
55
|
+
* `-o`, `--output=<dir>` — directory where generated HTML files are written.
|
56
|
+
* `-s`, `--stylesheet=<url>` — CSS stylesheet to use instead of default one.
|
53
57
|
|
54
58
|
### Rake task
|
55
59
|
|
56
60
|
Usage:
|
57
61
|
|
58
|
-
|
62
|
+
```ruby
|
63
|
+
Rokko::Task.new(:task_name, output_dir, filelist, opts)
|
64
|
+
```
|
59
65
|
|
60
66
|
Available options:
|
61
67
|
|
62
|
-
* `:local`
|
63
|
-
* `:index => true`
|
64
|
-
* `:index => <file>`
|
65
|
-
* `:stylesheet`
|
68
|
+
* `:local` — generate offline-ready documentation.
|
69
|
+
* `:index => true` — generate index.html with links (TOC) to all generated HTML files.
|
70
|
+
* `:index => <file>` — use `<file>` as index.html.
|
71
|
+
* `:stylesheet` — CSS stylesheet to use instead of default one.
|
66
72
|
|
data/Rakefile
CHANGED
@@ -1,10 +1,12 @@
|
|
1
1
|
$:.unshift(File.expand_path('lib'))
|
2
2
|
require 'rokko/task'
|
3
3
|
require 'rake/testtask'
|
4
|
+
require 'bundler'
|
5
|
+
Bundler::GemHelper.install_tasks
|
4
6
|
|
5
7
|
Rokko::Task.new(:rokko, 'docs', ['lib/**/*.rb', 'README.md'], {:index => true, :local => true})
|
6
8
|
|
7
9
|
Rake::TestTask.new do |t|
|
8
10
|
t.test_files = ['test/tests.rb']
|
9
11
|
t.verbose = true
|
10
|
-
end
|
12
|
+
end
|
data/lib/rokko/version.rb
CHANGED
data/rokko.gemspec
CHANGED
@@ -11,14 +11,14 @@ Gem::Specification.new do |s|
|
|
11
11
|
s.homepage = "http://vast.github.com/rokko/"
|
12
12
|
s.summary = %q{Else one ruby port of [Docco](http://jashkenas.github.com/docco/)}
|
13
13
|
s.description = %q[fat-free [rocco](http://rtomayko.github.com/rocco/)]
|
14
|
-
|
15
|
-
s.rubyforge_project = "rokko"
|
14
|
+
s.license = 'MIT'
|
16
15
|
|
17
16
|
s.files = `git ls-files`.split("\n")
|
18
17
|
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
19
18
|
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
20
19
|
s.require_paths = ["lib"]
|
21
|
-
|
20
|
+
|
22
21
|
s.add_dependency('mustache')
|
23
22
|
s.add_dependency('rdiscount')
|
23
|
+
s.add_development_dependency('rake')
|
24
24
|
end
|
metadata
CHANGED
@@ -1,46 +1,55 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rokko
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.5.
|
5
|
-
prerelease:
|
4
|
+
version: 0.5.1
|
6
5
|
platform: ruby
|
7
6
|
authors:
|
8
7
|
- Vasily Polovnyov
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date:
|
11
|
+
date: 2014-01-03 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: mustache
|
16
15
|
requirement: !ruby/object:Gem::Requirement
|
17
|
-
none: false
|
18
16
|
requirements:
|
19
|
-
- -
|
17
|
+
- - '>='
|
20
18
|
- !ruby/object:Gem::Version
|
21
19
|
version: '0'
|
22
20
|
type: :runtime
|
23
21
|
prerelease: false
|
24
22
|
version_requirements: !ruby/object:Gem::Requirement
|
25
|
-
none: false
|
26
23
|
requirements:
|
27
|
-
- -
|
24
|
+
- - '>='
|
28
25
|
- !ruby/object:Gem::Version
|
29
26
|
version: '0'
|
30
27
|
- !ruby/object:Gem::Dependency
|
31
28
|
name: rdiscount
|
32
29
|
requirement: !ruby/object:Gem::Requirement
|
33
|
-
none: false
|
34
30
|
requirements:
|
35
|
-
- -
|
31
|
+
- - '>='
|
36
32
|
- !ruby/object:Gem::Version
|
37
33
|
version: '0'
|
38
34
|
type: :runtime
|
39
35
|
prerelease: false
|
40
36
|
version_requirements: !ruby/object:Gem::Requirement
|
41
|
-
none: false
|
42
37
|
requirements:
|
43
|
-
- -
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
44
53
|
- !ruby/object:Gem::Version
|
45
54
|
version: '0'
|
46
55
|
description: fat-free [rocco](http://rtomayko.github.com/rocco/)
|
@@ -80,28 +89,28 @@ files:
|
|
80
89
|
- test/test_sources.rb
|
81
90
|
- test/tests.rb
|
82
91
|
homepage: http://vast.github.com/rokko/
|
83
|
-
licenses:
|
92
|
+
licenses:
|
93
|
+
- MIT
|
94
|
+
metadata: {}
|
84
95
|
post_install_message:
|
85
96
|
rdoc_options: []
|
86
97
|
require_paths:
|
87
98
|
- lib
|
88
99
|
required_ruby_version: !ruby/object:Gem::Requirement
|
89
|
-
none: false
|
90
100
|
requirements:
|
91
|
-
- -
|
101
|
+
- - '>='
|
92
102
|
- !ruby/object:Gem::Version
|
93
103
|
version: '0'
|
94
104
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
95
|
-
none: false
|
96
105
|
requirements:
|
97
|
-
- -
|
106
|
+
- - '>='
|
98
107
|
- !ruby/object:Gem::Version
|
99
108
|
version: '0'
|
100
109
|
requirements: []
|
101
|
-
rubyforge_project:
|
102
|
-
rubygems_version: 1.8
|
110
|
+
rubyforge_project:
|
111
|
+
rubygems_version: 2.1.8
|
103
112
|
signing_key:
|
104
|
-
specification_version:
|
113
|
+
specification_version: 4
|
105
114
|
summary: Else one ruby port of [Docco](http://jashkenas.github.com/docco/)
|
106
115
|
test_files:
|
107
116
|
- test/fixtures/block_comments.rb
|