sdoc 2.0.2 → 2.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +8 -0
- data/config.ru +30 -0
- data/lib/rdoc/generator/template/rails/index.rhtml +1 -1
- data/lib/sdoc/version.rb +1 -1
- data/sdoc.gemspec +2 -0
- metadata +17 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 234ba541d36b61d2b4bb680ab8df4e2463d4cc63f0517f160270a3e7a48f0f81
|
|
4
|
+
data.tar.gz: afae81f60c7f9218da174c06cb4d5799f7c0db8e5188c6dc49c54ea3bacb5dc3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3b24a3309f283113f8b0f0cd1e2e0d7711a40a293612599499f09b6d6793f25669e9aa0f9925ef9d844a31a89be30f296fdd8f47d3161a8f24629d5d2f41b99c
|
|
7
|
+
data.tar.gz: f5355d4fd9d7aa0478db5c6aa398502c1480ece246f811b795721471e15eddc74dafe7640cca5de2e32751a65d5fcea0d156933aa2eabc691d1daba222428fdd
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -101,6 +101,14 @@ rake test:rails
|
|
|
101
101
|
This task will generate documentation for the Rails master branch.
|
|
102
102
|
Since the task doesn't do any file filtering it contains a lot of extra pages.
|
|
103
103
|
|
|
104
|
+
To view the just generated documentation start up a rack application by running:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
rackup config.ru
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Then open http://localhost:9292 in the browser to view the documentation.
|
|
111
|
+
|
|
104
112
|
### Who?
|
|
105
113
|
|
|
106
114
|
* Vladimir Kolesnikov ([voloko](https://github.com/voloko))
|
data/config.ru
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Rack application for serving the documentation locally.
|
|
2
|
+
# After generating the documentation run:
|
|
3
|
+
#
|
|
4
|
+
# bundle exec rackup config.ru
|
|
5
|
+
#
|
|
6
|
+
require 'bundler/setup'
|
|
7
|
+
|
|
8
|
+
root = "doc/rails"
|
|
9
|
+
unless Dir.exists?(root)
|
|
10
|
+
puts <<~MESSAGE
|
|
11
|
+
Could not find any docs in #{root}.
|
|
12
|
+
Run the following command to generate sample documentation:
|
|
13
|
+
bundle exec rake test:rails
|
|
14
|
+
MESSAGE
|
|
15
|
+
exit
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
use Rack::Static,
|
|
19
|
+
:urls => ["/files", "/images", "/js", "/css", "/panel", "/i", "/classes"],
|
|
20
|
+
:root => root
|
|
21
|
+
run lambda { |env|
|
|
22
|
+
[
|
|
23
|
+
200,
|
|
24
|
+
{
|
|
25
|
+
'Content-Type' => 'text/html',
|
|
26
|
+
'Cache-Control' => 'public, max-age=86400'
|
|
27
|
+
},
|
|
28
|
+
File.open("#{root}/index.html", File::RDONLY)
|
|
29
|
+
]
|
|
30
|
+
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
4
4
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
5
|
<head>
|
|
6
|
-
<title><%=
|
|
6
|
+
<title><%= @options.title %></title>
|
|
7
7
|
<meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
|
|
8
8
|
<%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, tree_keys: []} %>
|
|
9
9
|
</head>
|
data/lib/sdoc/version.rb
CHANGED
data/sdoc.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0.
|
|
4
|
+
version: 2.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Vladimir Kolesnikov
|
|
@@ -11,7 +11,7 @@ authors:
|
|
|
11
11
|
autorequire:
|
|
12
12
|
bindir: bin
|
|
13
13
|
cert_chain: []
|
|
14
|
-
date: 2020-11
|
|
14
|
+
date: 2020-12-11 00:00:00.000000000 Z
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
17
17
|
name: rdoc
|
|
@@ -27,6 +27,20 @@ dependencies:
|
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
29
|
version: '5.0'
|
|
30
|
+
- !ruby/object:Gem::Dependency
|
|
31
|
+
name: rack
|
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
|
33
|
+
requirements:
|
|
34
|
+
- - ">="
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: '0'
|
|
37
|
+
type: :development
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - ">="
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: '0'
|
|
30
44
|
description: rdoc generator html with javascript search index.
|
|
31
45
|
email: voloko@gmail.com mail@zzak.io
|
|
32
46
|
executables:
|
|
@@ -45,6 +59,7 @@ files:
|
|
|
45
59
|
- Rakefile
|
|
46
60
|
- bin/sdoc
|
|
47
61
|
- bin/sdoc-merge
|
|
62
|
+
- config.ru
|
|
48
63
|
- lib/rdoc/discover.rb
|
|
49
64
|
- lib/rdoc/generator/template/merge/index.rhtml
|
|
50
65
|
- lib/rdoc/generator/template/rails/_context.rhtml
|