rdoc 6.7.0 → 6.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/ExampleMarkdown.md +2 -0
- data/ExampleRDoc.rdoc +2 -0
- data/History.rdoc +64 -62
- data/LICENSE.rdoc +2 -0
- data/README.rdoc +13 -0
- data/RI.md +842 -0
- data/TODO.rdoc +8 -7
- data/lib/rdoc/{alias.rb → code_object/alias.rb} +1 -1
- data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +54 -0
- data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +3 -3
- data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +4 -4
- data/lib/rdoc/code_object.rb +6 -0
- data/lib/rdoc/generator/darkfish.rb +45 -3
- data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
- data/lib/rdoc/generator/pot/po_entry.rb +1 -1
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
- data/lib/rdoc/generator/template/darkfish/class.rhtml +69 -43
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +367 -392
- data/lib/rdoc/generator/template/darkfish/index.rhtml +7 -6
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +18 -1
- data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
- data/lib/rdoc/markdown.kpeg +1 -1
- data/lib/rdoc/markdown.rb +21 -11
- data/lib/rdoc/markup/attribute_manager.rb +2 -2
- data/lib/rdoc/markup/pre_process.rb +9 -6
- data/lib/rdoc/markup/to_bs.rb +1 -1
- data/lib/rdoc/markup/to_rdoc.rb +4 -4
- data/lib/rdoc/markup.rb +18 -13
- data/lib/rdoc/options.rb +22 -5
- data/lib/rdoc/parser/c.rb +1 -1
- data/lib/rdoc/parser/changelog.rb +2 -2
- data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
- data/lib/rdoc/parser/ruby.rb +15 -6
- data/lib/rdoc/parser.rb +2 -1
- data/lib/rdoc/rdoc.rb +3 -2
- data/lib/rdoc/ri/driver.rb +10 -6
- data/lib/rdoc/task.rb +2 -3
- data/lib/rdoc/tom_doc.rb +1 -7
- data/lib/rdoc/version.rb +1 -1
- data/lib/rdoc.rb +22 -22
- metadata +28 -24
- data/RI.rdoc +0 -57
- /data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
- /data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +0 -0
- /data/lib/rdoc/{attr.rb → code_object/attr.rb} +0 -0
- /data/lib/rdoc/{constant.rb → code_object/constant.rb} +0 -0
- /data/lib/rdoc/{context → code_object/context}/section.rb +0 -0
- /data/lib/rdoc/{context.rb → code_object/context.rb} +0 -0
- /data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
- /data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
- /data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
- /data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
- /data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
- /data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
- /data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
- /data/lib/rdoc/{require.rb → code_object/require.rb} +0 -0
- /data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 6.
|
4
|
+
version: 6.8.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Eric Hodel
|
@@ -11,9 +11,10 @@ authors:
|
|
11
11
|
- Zachary Scott
|
12
12
|
- Hiroshi SHIBATA
|
13
13
|
- ITOYANAGI Sakura
|
14
|
+
autorequire:
|
14
15
|
bindir: exe
|
15
16
|
cert_chain: []
|
16
|
-
date: 2024-
|
17
|
+
date: 2024-11-19 00:00:00.000000000 Z
|
17
18
|
dependencies:
|
18
19
|
- !ruby/object:Gem::Dependency
|
19
20
|
name: psych
|
@@ -53,7 +54,7 @@ extra_rdoc_files:
|
|
53
54
|
- LEGAL.rdoc
|
54
55
|
- LICENSE.rdoc
|
55
56
|
- README.rdoc
|
56
|
-
- RI.
|
57
|
+
- RI.md
|
57
58
|
- TODO.rdoc
|
58
59
|
files:
|
59
60
|
- CONTRIBUTING.rdoc
|
@@ -64,27 +65,37 @@ files:
|
|
64
65
|
- LEGAL.rdoc
|
65
66
|
- LICENSE.rdoc
|
66
67
|
- README.rdoc
|
67
|
-
- RI.
|
68
|
+
- RI.md
|
68
69
|
- TODO.rdoc
|
69
70
|
- exe/rdoc
|
70
71
|
- exe/ri
|
71
72
|
- lib/rdoc.rb
|
72
|
-
- lib/rdoc/alias.rb
|
73
|
-
- lib/rdoc/anon_class.rb
|
74
|
-
- lib/rdoc/any_method.rb
|
75
|
-
- lib/rdoc/attr.rb
|
76
|
-
- lib/rdoc/class_module.rb
|
77
73
|
- lib/rdoc/code_object.rb
|
74
|
+
- lib/rdoc/code_object/alias.rb
|
75
|
+
- lib/rdoc/code_object/anon_class.rb
|
76
|
+
- lib/rdoc/code_object/any_method.rb
|
77
|
+
- lib/rdoc/code_object/attr.rb
|
78
|
+
- lib/rdoc/code_object/class_module.rb
|
79
|
+
- lib/rdoc/code_object/constant.rb
|
80
|
+
- lib/rdoc/code_object/context.rb
|
81
|
+
- lib/rdoc/code_object/context/section.rb
|
82
|
+
- lib/rdoc/code_object/extend.rb
|
83
|
+
- lib/rdoc/code_object/ghost_method.rb
|
84
|
+
- lib/rdoc/code_object/include.rb
|
85
|
+
- lib/rdoc/code_object/meta_method.rb
|
86
|
+
- lib/rdoc/code_object/method_attr.rb
|
87
|
+
- lib/rdoc/code_object/mixin.rb
|
88
|
+
- lib/rdoc/code_object/normal_class.rb
|
89
|
+
- lib/rdoc/code_object/normal_module.rb
|
90
|
+
- lib/rdoc/code_object/require.rb
|
91
|
+
- lib/rdoc/code_object/single_class.rb
|
92
|
+
- lib/rdoc/code_object/top_level.rb
|
78
93
|
- lib/rdoc/code_objects.rb
|
79
94
|
- lib/rdoc/comment.rb
|
80
|
-
- lib/rdoc/constant.rb
|
81
|
-
- lib/rdoc/context.rb
|
82
|
-
- lib/rdoc/context/section.rb
|
83
95
|
- lib/rdoc/cross_reference.rb
|
84
96
|
- lib/rdoc/encoding.rb
|
85
97
|
- lib/rdoc/erb_partial.rb
|
86
98
|
- lib/rdoc/erbio.rb
|
87
|
-
- lib/rdoc/extend.rb
|
88
99
|
- lib/rdoc/generator.rb
|
89
100
|
- lib/rdoc/generator/darkfish.rb
|
90
101
|
- lib/rdoc/generator/json_index.rb
|
@@ -110,6 +121,7 @@ files:
|
|
110
121
|
- lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
|
111
122
|
- lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
|
112
123
|
- lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
|
124
|
+
- lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml
|
113
125
|
- lib/rdoc/generator/template/darkfish/class.rhtml
|
114
126
|
- lib/rdoc/generator/template/darkfish/css/fonts.css
|
115
127
|
- lib/rdoc/generator/template/darkfish/css/rdoc.css
|
@@ -154,11 +166,9 @@ files:
|
|
154
166
|
- lib/rdoc/generator/template/json_index/.document
|
155
167
|
- lib/rdoc/generator/template/json_index/js/navigation.js
|
156
168
|
- lib/rdoc/generator/template/json_index/js/searcher.js
|
157
|
-
- lib/rdoc/ghost_method.rb
|
158
169
|
- lib/rdoc/i18n.rb
|
159
170
|
- lib/rdoc/i18n/locale.rb
|
160
171
|
- lib/rdoc/i18n/text.rb
|
161
|
-
- lib/rdoc/include.rb
|
162
172
|
- lib/rdoc/known_classes.rb
|
163
173
|
- lib/rdoc/markdown.kpeg
|
164
174
|
- lib/rdoc/markdown.rb
|
@@ -200,11 +210,6 @@ files:
|
|
200
210
|
- lib/rdoc/markup/to_test.rb
|
201
211
|
- lib/rdoc/markup/to_tt_only.rb
|
202
212
|
- lib/rdoc/markup/verbatim.rb
|
203
|
-
- lib/rdoc/meta_method.rb
|
204
|
-
- lib/rdoc/method_attr.rb
|
205
|
-
- lib/rdoc/mixin.rb
|
206
|
-
- lib/rdoc/normal_class.rb
|
207
|
-
- lib/rdoc/normal_module.rb
|
208
213
|
- lib/rdoc/options.rb
|
209
214
|
- lib/rdoc/parser.rb
|
210
215
|
- lib/rdoc/parser/c.rb
|
@@ -223,7 +228,6 @@ files:
|
|
223
228
|
- lib/rdoc/rd/inline_parser.rb
|
224
229
|
- lib/rdoc/rd/inline_parser.ry
|
225
230
|
- lib/rdoc/rdoc.rb
|
226
|
-
- lib/rdoc/require.rb
|
227
231
|
- lib/rdoc/ri.rb
|
228
232
|
- lib/rdoc/ri/driver.rb
|
229
233
|
- lib/rdoc/ri/formatter.rb
|
@@ -232,7 +236,6 @@ files:
|
|
232
236
|
- lib/rdoc/ri/task.rb
|
233
237
|
- lib/rdoc/rubygems_hook.rb
|
234
238
|
- lib/rdoc/servlet.rb
|
235
|
-
- lib/rdoc/single_class.rb
|
236
239
|
- lib/rdoc/stats.rb
|
237
240
|
- lib/rdoc/stats/normal.rb
|
238
241
|
- lib/rdoc/stats/quiet.rb
|
@@ -242,7 +245,6 @@ files:
|
|
242
245
|
- lib/rdoc/text.rb
|
243
246
|
- lib/rdoc/token_stream.rb
|
244
247
|
- lib/rdoc/tom_doc.rb
|
245
|
-
- lib/rdoc/top_level.rb
|
246
248
|
- lib/rdoc/version.rb
|
247
249
|
- man/ri.1
|
248
250
|
homepage: https://ruby.github.io/rdoc
|
@@ -252,6 +254,7 @@ metadata:
|
|
252
254
|
homepage_uri: https://ruby.github.io/rdoc
|
253
255
|
source_code_uri: https://github.com/ruby/rdoc
|
254
256
|
changelog_uri: https://github.com/ruby/rdoc/releases
|
257
|
+
post_install_message:
|
255
258
|
rdoc_options:
|
256
259
|
- "--main"
|
257
260
|
- README.rdoc
|
@@ -268,7 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
268
271
|
- !ruby/object:Gem::Version
|
269
272
|
version: '2.2'
|
270
273
|
requirements: []
|
271
|
-
rubygems_version: 3.
|
274
|
+
rubygems_version: 3.5.11
|
275
|
+
signing_key:
|
272
276
|
specification_version: 4
|
273
277
|
summary: RDoc produces HTML and command-line documentation for Ruby projects
|
274
278
|
test_files: []
|
data/RI.rdoc
DELETED
@@ -1,57 +0,0 @@
|
|
1
|
-
= RI
|
2
|
-
|
3
|
-
+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
|
4
|
-
|
5
|
-
You can use +ri+ to look up information from either the command line or
|
6
|
-
interactively. When you run +ri+ without any arguments it will launch in
|
7
|
-
interactive mode. In interactive mode you can tab-complete class and method
|
8
|
-
names.
|
9
|
-
|
10
|
-
== Usage
|
11
|
-
|
12
|
-
To see information for a class, do:
|
13
|
-
ri ClassName
|
14
|
-
|
15
|
-
For example, for the Array class, do:
|
16
|
-
ri Array
|
17
|
-
|
18
|
-
To see information on a method on a class, do:
|
19
|
-
ri ClassName.method
|
20
|
-
|
21
|
-
This will show both instance and class methods. For example, the IO
|
22
|
-
class defines both IO::read and IO#read:
|
23
|
-
ri IO.read
|
24
|
-
|
25
|
-
To see information for an instance method, do:
|
26
|
-
ri ClassName#method_name
|
27
|
-
|
28
|
-
For example, for Array's +join+ method, do:
|
29
|
-
ri Array#join
|
30
|
-
|
31
|
-
To see information for a class method, do:
|
32
|
-
ri ClassName::method_name
|
33
|
-
|
34
|
-
For example, for Module's +private+ method, do:
|
35
|
-
ri Module::private
|
36
|
-
|
37
|
-
To read documentation for all +read+ methods, do:
|
38
|
-
ri read
|
39
|
-
|
40
|
-
== Options
|
41
|
-
|
42
|
-
+ri+ supports a variety of options, all of which can be viewed via +--help+.
|
43
|
-
Of particular interest, are:
|
44
|
-
|
45
|
-
[<tt>-f</tt>]
|
46
|
-
Outputs ri data using the selected formatter. You can see the available
|
47
|
-
formatters in <tt>ri --help</tt>
|
48
|
-
[<tt>-T</tt>]
|
49
|
-
Send output to stdout, rather than to a pager.
|
50
|
-
|
51
|
-
All options also can be specified through the +RI+ environment variable.
|
52
|
-
Command-line options always override those specified in the +RI+ environment
|
53
|
-
variable.
|
54
|
-
|
55
|
-
The +RI_PAGER+ environment variable allows you to choose a particular pager or
|
56
|
-
particular options for your pager.
|
57
|
-
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|