voloko-sdoc 0.2.5 → 0.2.6
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +38 -0
- data/VERSION.yml +1 -1
- data/lib/sdoc/generator/template/direct/file.rhtml +2 -1
- data/lib/sdoc/generator/template/direct/resources/css/main.css +13 -1
- metadata +4 -4
- data/README +0 -7
data/README.rdoc
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
= SDoc
|
|
2
|
+
== What's in?
|
|
3
|
+
- shtml - RDoc's generator to build searchable documentation
|
|
4
|
+
- <tt>sdoc-merge</tt> - comand line tool to build merge multiple sdoc documentations
|
|
5
|
+
packages into a single one
|
|
6
|
+
- <tt>sdoc</tt> - command line tool to run rdoc with generator=shtml
|
|
7
|
+
|
|
8
|
+
== Getting Started
|
|
9
|
+
gem sources -a http://gems.github.com
|
|
10
|
+
sudo gem install voloko-sdoc
|
|
11
|
+
sdoc -N projectdir
|
|
12
|
+
|
|
13
|
+
== Command line sdoc
|
|
14
|
+
sdoc is simply a wrapper to rdoc command line tool. see <tt>sdoc --help </tt>
|
|
15
|
+
for more details. <tt>--fmt</tt> is set to shtml by default.
|
|
16
|
+
Default template <tt>-T</tt> is shtml. You can also use 'direct' template.
|
|
17
|
+
Example:
|
|
18
|
+
<tt>sdoc -o doc/rails -T direct rails</tt>
|
|
19
|
+
|
|
20
|
+
== Rake
|
|
21
|
+
# Rakefile
|
|
22
|
+
require 'sdoc' # and use your RDoc task the same way you used it before
|
|
23
|
+
|
|
24
|
+
Rake::RDocTask.new do |rdoc|
|
|
25
|
+
rdoc.rdoc_dir = 'doc/rdoc'
|
|
26
|
+
rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
|
|
27
|
+
rdoc.template = 'direct' # lighter template used on railsapi.com
|
|
28
|
+
...
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
== sdoc-merge
|
|
32
|
+
Usage: sdoc-merge [options] directories
|
|
33
|
+
-n, --names [NAMES] Names of merged repositories. Comma separated
|
|
34
|
+
-o, --op [DIRECTORY] Set the output directory
|
|
35
|
+
-t, --title [TITLE] Set the title of merged file
|
|
36
|
+
|
|
37
|
+
Example:
|
|
38
|
+
<tt>sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1</tt>
|
data/VERSION.yml
CHANGED
|
@@ -15,10 +15,11 @@
|
|
|
15
15
|
<body>
|
|
16
16
|
<div class="banner">
|
|
17
17
|
<h1>
|
|
18
|
-
|
|
18
|
+
<%= h file.name %>
|
|
19
19
|
</h1>
|
|
20
20
|
<ul class="files">
|
|
21
21
|
<li><%= h file.relative_name %></li>
|
|
22
|
+
<li>Last modified: <%= file.file_stat.mtime %></li>
|
|
22
23
|
</ul>
|
|
23
24
|
</div>
|
|
24
25
|
|
|
@@ -36,7 +36,10 @@ h2 {
|
|
|
36
36
|
}
|
|
37
37
|
|
|
38
38
|
h3 {
|
|
39
|
-
|
|
39
|
+
font-size: 1.4em;
|
|
40
|
+
color:#555;
|
|
41
|
+
margin: 1.4em 0 0.7em 0;
|
|
42
|
+
font-weight: normal;
|
|
40
43
|
}
|
|
41
44
|
|
|
42
45
|
h4 {
|
|
@@ -55,9 +58,18 @@ h4 {
|
|
|
55
58
|
li
|
|
56
59
|
{
|
|
57
60
|
margin: 0 0 0.5em 2em;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
ul li
|
|
64
|
+
{
|
|
58
65
|
list-style: disc;
|
|
59
66
|
}
|
|
60
67
|
|
|
68
|
+
ol li
|
|
69
|
+
{
|
|
70
|
+
list-style: decimal;
|
|
71
|
+
}
|
|
72
|
+
|
|
61
73
|
.banner
|
|
62
74
|
{
|
|
63
75
|
background: #EDF3FE;
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: voloko-sdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Volodya Kolesnikov
|
|
@@ -9,7 +9,7 @@ autorequire:
|
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
11
|
|
|
12
|
-
date: 2009-04-
|
|
12
|
+
date: 2009-04-08 00:00:00 -07:00
|
|
13
13
|
default_executable:
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
@@ -40,9 +40,10 @@ executables:
|
|
|
40
40
|
extensions: []
|
|
41
41
|
|
|
42
42
|
extra_rdoc_files:
|
|
43
|
-
- README
|
|
43
|
+
- README.rdoc
|
|
44
44
|
- LICENSE
|
|
45
45
|
files:
|
|
46
|
+
- README.rdoc
|
|
46
47
|
- VERSION.yml
|
|
47
48
|
- bin/sdoc
|
|
48
49
|
- bin/sdoc-merge
|
|
@@ -99,7 +100,6 @@ files:
|
|
|
99
100
|
- lib/sdoc/merge.rb
|
|
100
101
|
- lib/sdoc/templatable.rb
|
|
101
102
|
- lib/sdoc.rb
|
|
102
|
-
- README
|
|
103
103
|
- LICENSE
|
|
104
104
|
has_rdoc: true
|
|
105
105
|
homepage: http://github.com/voloko/sdoc
|