rdoc 5.1.0 → 6.13.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 +5 -5
- data/CONTRIBUTING.rdoc +5 -6
- data/ExampleMarkdown.md +2 -0
- data/ExampleRDoc.rdoc +2 -0
- data/History.rdoc +68 -66
- data/LEGAL.rdoc +1 -1
- data/LICENSE.rdoc +2 -0
- data/README.rdoc +18 -6
- data/RI.md +842 -0
- data/TODO.rdoc +8 -7
- data/exe/rdoc +0 -1
- data/lib/rdoc/{alias.rb → code_object/alias.rb} +4 -12
- data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +1 -2
- data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +83 -26
- data/lib/rdoc/{attr.rb → code_object/attr.rb} +5 -9
- data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +112 -24
- data/lib/rdoc/{constant.rb → code_object/constant.rb} +4 -5
- data/lib/rdoc/{context → code_object/context}/section.rb +13 -83
- data/lib/rdoc/{context.rb → code_object/context.rb} +69 -70
- data/lib/rdoc/{extend.rb → code_object/extend.rb} +1 -2
- data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +1 -2
- data/lib/rdoc/{include.rb → code_object/include.rb} +1 -2
- data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +1 -2
- data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +22 -31
- data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +1 -2
- data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +4 -5
- data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +2 -3
- data/lib/rdoc/{require.rb → code_object/require.rb} +2 -3
- data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +6 -2
- data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +22 -32
- data/lib/rdoc/code_object.rb +8 -41
- data/lib/rdoc/code_objects.rb +2 -3
- data/lib/rdoc/comment.rb +48 -41
- data/lib/rdoc/cross_reference.rb +77 -33
- data/lib/rdoc/encoding.rb +50 -38
- data/lib/rdoc/erb_partial.rb +2 -3
- data/lib/rdoc/erbio.rb +4 -5
- data/lib/rdoc/generator/darkfish.rb +178 -125
- data/lib/rdoc/generator/json_index.rb +9 -22
- data/lib/rdoc/generator/markup.rb +6 -17
- data/lib/rdoc/generator/pot/message_extractor.rb +4 -4
- data/lib/rdoc/generator/pot/po.rb +3 -3
- data/lib/rdoc/generator/pot/po_entry.rb +12 -12
- data/lib/rdoc/generator/pot.rb +4 -8
- data/lib/rdoc/generator/ri.rb +1 -2
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +35 -12
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +1 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +19 -10
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +26 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +4 -9
- data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +1 -1
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +27 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
- data/lib/rdoc/generator/template/darkfish/class.rhtml +125 -78
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +430 -339
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/index.rhtml +13 -13
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +51 -92
- data/lib/rdoc/generator/template/darkfish/js/search.js +35 -34
- 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 +20 -18
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +32 -20
- data/lib/rdoc/generator/template/json_index/js/navigation.js +12 -49
- data/lib/rdoc/generator/template/json_index/js/searcher.js +6 -6
- data/lib/rdoc/generator.rb +6 -6
- data/lib/rdoc/i18n/locale.rb +1 -1
- data/lib/rdoc/i18n/text.rb +5 -5
- data/lib/rdoc/i18n.rb +4 -4
- data/lib/rdoc/known_classes.rb +6 -5
- data/lib/rdoc/markdown/entities.rb +1 -2
- data/lib/rdoc/markdown/literals.kpeg +1 -2
- data/lib/rdoc/markdown/literals.rb +99 -50
- data/lib/rdoc/markdown.kpeg +115 -58
- data/lib/rdoc/markdown.rb +1584 -902
- data/lib/rdoc/markup/attr_changer.rb +1 -2
- data/lib/rdoc/markup/attr_span.rb +9 -4
- data/lib/rdoc/markup/attribute_manager.rb +118 -57
- data/lib/rdoc/markup/attributes.rb +7 -8
- data/lib/rdoc/markup/blank_line.rb +1 -2
- data/lib/rdoc/markup/block_quote.rb +1 -2
- data/lib/rdoc/markup/document.rb +1 -2
- data/lib/rdoc/markup/formatter.rb +44 -37
- data/lib/rdoc/markup/hard_break.rb +1 -2
- data/lib/rdoc/markup/heading.rb +11 -6
- data/lib/rdoc/markup/include.rb +1 -2
- data/lib/rdoc/markup/indented_paragraph.rb +1 -2
- data/lib/rdoc/markup/list.rb +1 -2
- data/lib/rdoc/markup/list_item.rb +1 -2
- data/lib/rdoc/markup/paragraph.rb +1 -2
- data/lib/rdoc/markup/parser.rb +90 -48
- data/lib/rdoc/markup/pre_process.rb +38 -11
- data/lib/rdoc/markup/raw.rb +1 -2
- data/lib/rdoc/markup/regexp_handling.rb +40 -0
- data/lib/rdoc/markup/rule.rb +1 -2
- data/lib/rdoc/markup/table.rb +56 -0
- data/lib/rdoc/markup/to_ansi.rb +1 -2
- data/lib/rdoc/markup/to_bs.rb +30 -5
- data/lib/rdoc/markup/to_html.rb +95 -40
- data/lib/rdoc/markup/to_html_crossref.rb +108 -43
- data/lib/rdoc/markup/to_html_snippet.rb +13 -11
- data/lib/rdoc/markup/to_joined_paragraph.rb +6 -32
- data/lib/rdoc/markup/to_label.rb +11 -12
- data/lib/rdoc/markup/to_markdown.rb +13 -14
- data/lib/rdoc/markup/to_rdoc.rb +49 -31
- data/lib/rdoc/markup/to_table_of_contents.rb +2 -2
- data/lib/rdoc/markup/to_test.rb +1 -2
- data/lib/rdoc/markup/to_tt_only.rb +3 -4
- data/lib/rdoc/markup/verbatim.rb +1 -2
- data/lib/rdoc/markup.rb +64 -694
- data/lib/rdoc/options.rb +226 -44
- data/lib/rdoc/parser/c.rb +231 -246
- data/lib/rdoc/parser/changelog.rb +169 -23
- data/lib/rdoc/parser/markdown.rb +1 -3
- data/lib/rdoc/parser/prism_ruby.rb +1092 -0
- data/lib/rdoc/parser/rd.rb +1 -2
- data/lib/rdoc/parser/ripper_state_lex.rb +302 -0
- data/lib/rdoc/parser/ruby.rb +695 -478
- data/lib/rdoc/parser/ruby_tools.rb +33 -36
- data/lib/rdoc/parser/simple.rb +4 -4
- data/lib/rdoc/parser/text.rb +1 -2
- data/lib/rdoc/parser.rb +37 -42
- data/lib/rdoc/rd/block_parser.rb +708 -57
- data/lib/rdoc/rd/block_parser.ry +15 -11
- data/lib/rdoc/rd/inline.rb +5 -6
- data/lib/rdoc/rd/inline_parser.rb +787 -140
- data/lib/rdoc/rd/inline_parser.ry +1 -1
- data/lib/rdoc/rd.rb +4 -5
- data/lib/rdoc/rdoc.rb +72 -87
- data/lib/rdoc/ri/driver.rb +236 -152
- data/lib/rdoc/ri/formatter.rb +1 -1
- data/lib/rdoc/ri/paths.rb +4 -18
- data/lib/rdoc/ri/store.rb +1 -2
- data/lib/rdoc/ri/task.rb +2 -2
- data/lib/rdoc/ri.rb +5 -6
- data/lib/rdoc/rubygems_hook.rb +98 -20
- data/lib/rdoc/servlet.rb +30 -20
- data/lib/rdoc/stats/normal.rb +24 -18
- data/lib/rdoc/stats/quiet.rb +1 -2
- data/lib/rdoc/stats/verbose.rb +1 -3
- data/lib/rdoc/stats.rb +6 -7
- data/lib/rdoc/store.rb +84 -55
- data/lib/rdoc/task.rb +35 -10
- data/lib/rdoc/text.rb +40 -27
- data/lib/rdoc/token_stream.rb +56 -34
- data/lib/rdoc/tom_doc.rb +18 -19
- data/lib/rdoc/version.rb +10 -0
- data/lib/rdoc.rb +80 -56
- data/lib/rubygems_plugin.rb +23 -0
- data/man/ri.1 +247 -0
- metadata +45 -99
- data/.document +0 -5
- data/.gitignore +0 -13
- data/.travis.yml +0 -24
- data/Gemfile +0 -3
- data/RI.rdoc +0 -57
- data/Rakefile +0 -133
- data/bin/console +0 -7
- data/bin/setup +0 -6
- data/lib/gauntlet_rdoc.rb +0 -82
- data/lib/rdoc/generator/template/darkfish/.document +0 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +0 -19
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +0 -9
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
- data/lib/rdoc/generator/template/json_index/.document +0 -1
- data/lib/rdoc/markup/formatter_test_case.rb +0 -764
- data/lib/rdoc/markup/inline.rb +0 -2
- data/lib/rdoc/markup/special.rb +0 -41
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -115
- data/lib/rdoc/ruby_lex.rb +0 -1367
- data/lib/rdoc/ruby_token.rb +0 -461
- data/lib/rdoc/test_case.rb +0 -204
- data/rdoc.gemspec +0 -57
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:
|
4
|
+
version: 6.13.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Eric Hodel
|
@@ -10,67 +10,25 @@ authors:
|
|
10
10
|
- Tony Strauss
|
11
11
|
- Zachary Scott
|
12
12
|
- Hiroshi SHIBATA
|
13
|
-
|
13
|
+
- ITOYANAGI Sakura
|
14
14
|
bindir: exe
|
15
15
|
cert_chain: []
|
16
|
-
date:
|
16
|
+
date: 2025-03-29 00:00:00.000000000 Z
|
17
17
|
dependencies:
|
18
18
|
- !ruby/object:Gem::Dependency
|
19
|
-
name:
|
19
|
+
name: psych
|
20
20
|
requirement: !ruby/object:Gem::Requirement
|
21
21
|
requirements:
|
22
22
|
- - ">="
|
23
23
|
- !ruby/object:Gem::Version
|
24
|
-
version:
|
25
|
-
type: :
|
24
|
+
version: 4.0.0
|
25
|
+
type: :runtime
|
26
26
|
prerelease: false
|
27
27
|
version_requirements: !ruby/object:Gem::Requirement
|
28
28
|
requirements:
|
29
29
|
- - ">="
|
30
30
|
- !ruby/object:Gem::Version
|
31
|
-
version:
|
32
|
-
- !ruby/object:Gem::Dependency
|
33
|
-
name: racc
|
34
|
-
requirement: !ruby/object:Gem::Requirement
|
35
|
-
requirements:
|
36
|
-
- - ">"
|
37
|
-
- !ruby/object:Gem::Version
|
38
|
-
version: 1.4.10
|
39
|
-
type: :development
|
40
|
-
prerelease: false
|
41
|
-
version_requirements: !ruby/object:Gem::Requirement
|
42
|
-
requirements:
|
43
|
-
- - ">"
|
44
|
-
- !ruby/object:Gem::Version
|
45
|
-
version: 1.4.10
|
46
|
-
- !ruby/object:Gem::Dependency
|
47
|
-
name: kpeg
|
48
|
-
requirement: !ruby/object:Gem::Requirement
|
49
|
-
requirements:
|
50
|
-
- - ">="
|
51
|
-
- !ruby/object:Gem::Version
|
52
|
-
version: '0'
|
53
|
-
type: :development
|
54
|
-
prerelease: false
|
55
|
-
version_requirements: !ruby/object:Gem::Requirement
|
56
|
-
requirements:
|
57
|
-
- - ">="
|
58
|
-
- !ruby/object:Gem::Version
|
59
|
-
version: '0'
|
60
|
-
- !ruby/object:Gem::Dependency
|
61
|
-
name: minitest
|
62
|
-
requirement: !ruby/object:Gem::Requirement
|
63
|
-
requirements:
|
64
|
-
- - "~>"
|
65
|
-
- !ruby/object:Gem::Version
|
66
|
-
version: '4'
|
67
|
-
type: :development
|
68
|
-
prerelease: false
|
69
|
-
version_requirements: !ruby/object:Gem::Requirement
|
70
|
-
requirements:
|
71
|
-
- - "~>"
|
72
|
-
- !ruby/object:Gem::Version
|
73
|
-
version: '4'
|
31
|
+
version: 4.0.0
|
74
32
|
description: |
|
75
33
|
RDoc produces HTML and command-line documentation for Ruby projects.
|
76
34
|
RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
|
@@ -81,59 +39,62 @@ email:
|
|
81
39
|
- ''
|
82
40
|
- mail@zzak.io
|
83
41
|
- hsbt@ruby-lang.org
|
42
|
+
- aycabta@gmail.com
|
84
43
|
executables:
|
85
44
|
- rdoc
|
86
45
|
- ri
|
87
46
|
extensions: []
|
88
47
|
extra_rdoc_files:
|
89
|
-
- CVE-2013-0256.rdoc
|
90
48
|
- CONTRIBUTING.rdoc
|
49
|
+
- CVE-2013-0256.rdoc
|
91
50
|
- ExampleMarkdown.md
|
92
51
|
- ExampleRDoc.rdoc
|
93
52
|
- History.rdoc
|
94
53
|
- LEGAL.rdoc
|
95
54
|
- LICENSE.rdoc
|
96
55
|
- README.rdoc
|
97
|
-
- RI.
|
56
|
+
- RI.md
|
98
57
|
- TODO.rdoc
|
99
58
|
files:
|
100
|
-
- ".document"
|
101
|
-
- ".gitignore"
|
102
|
-
- ".travis.yml"
|
103
59
|
- CONTRIBUTING.rdoc
|
104
60
|
- CVE-2013-0256.rdoc
|
105
61
|
- ExampleMarkdown.md
|
106
62
|
- ExampleRDoc.rdoc
|
107
|
-
- Gemfile
|
108
63
|
- History.rdoc
|
109
64
|
- LEGAL.rdoc
|
110
65
|
- LICENSE.rdoc
|
111
66
|
- README.rdoc
|
112
|
-
- RI.
|
113
|
-
- Rakefile
|
67
|
+
- RI.md
|
114
68
|
- TODO.rdoc
|
115
|
-
- bin/console
|
116
|
-
- bin/setup
|
117
69
|
- exe/rdoc
|
118
70
|
- exe/ri
|
119
|
-
- lib/gauntlet_rdoc.rb
|
120
71
|
- lib/rdoc.rb
|
121
|
-
- lib/rdoc/alias.rb
|
122
|
-
- lib/rdoc/anon_class.rb
|
123
|
-
- lib/rdoc/any_method.rb
|
124
|
-
- lib/rdoc/attr.rb
|
125
|
-
- lib/rdoc/class_module.rb
|
126
72
|
- lib/rdoc/code_object.rb
|
73
|
+
- lib/rdoc/code_object/alias.rb
|
74
|
+
- lib/rdoc/code_object/anon_class.rb
|
75
|
+
- lib/rdoc/code_object/any_method.rb
|
76
|
+
- lib/rdoc/code_object/attr.rb
|
77
|
+
- lib/rdoc/code_object/class_module.rb
|
78
|
+
- lib/rdoc/code_object/constant.rb
|
79
|
+
- lib/rdoc/code_object/context.rb
|
80
|
+
- lib/rdoc/code_object/context/section.rb
|
81
|
+
- lib/rdoc/code_object/extend.rb
|
82
|
+
- lib/rdoc/code_object/ghost_method.rb
|
83
|
+
- lib/rdoc/code_object/include.rb
|
84
|
+
- lib/rdoc/code_object/meta_method.rb
|
85
|
+
- lib/rdoc/code_object/method_attr.rb
|
86
|
+
- lib/rdoc/code_object/mixin.rb
|
87
|
+
- lib/rdoc/code_object/normal_class.rb
|
88
|
+
- lib/rdoc/code_object/normal_module.rb
|
89
|
+
- lib/rdoc/code_object/require.rb
|
90
|
+
- lib/rdoc/code_object/single_class.rb
|
91
|
+
- lib/rdoc/code_object/top_level.rb
|
127
92
|
- lib/rdoc/code_objects.rb
|
128
93
|
- lib/rdoc/comment.rb
|
129
|
-
- lib/rdoc/constant.rb
|
130
|
-
- lib/rdoc/context.rb
|
131
|
-
- lib/rdoc/context/section.rb
|
132
94
|
- lib/rdoc/cross_reference.rb
|
133
95
|
- lib/rdoc/encoding.rb
|
134
96
|
- lib/rdoc/erb_partial.rb
|
135
97
|
- lib/rdoc/erbio.rb
|
136
|
-
- lib/rdoc/extend.rb
|
137
98
|
- lib/rdoc/generator.rb
|
138
99
|
- lib/rdoc/generator/darkfish.rb
|
139
100
|
- lib/rdoc/generator/json_index.rb
|
@@ -143,13 +104,10 @@ files:
|
|
143
104
|
- lib/rdoc/generator/pot/po.rb
|
144
105
|
- lib/rdoc/generator/pot/po_entry.rb
|
145
106
|
- lib/rdoc/generator/ri.rb
|
146
|
-
- lib/rdoc/generator/template/darkfish/.document
|
147
107
|
- lib/rdoc/generator/template/darkfish/_footer.rhtml
|
148
108
|
- lib/rdoc/generator/template/darkfish/_head.rhtml
|
149
|
-
- lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
|
150
109
|
- lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
|
151
110
|
- lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml
|
152
|
-
- lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
|
153
111
|
- lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
|
154
112
|
- lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml
|
155
113
|
- lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
|
@@ -159,6 +117,7 @@ files:
|
|
159
117
|
- lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
|
160
118
|
- lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
|
161
119
|
- lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
|
120
|
+
- lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml
|
162
121
|
- lib/rdoc/generator/template/darkfish/class.rhtml
|
163
122
|
- lib/rdoc/generator/template/darkfish/css/fonts.css
|
164
123
|
- lib/rdoc/generator/template/darkfish/css/rdoc.css
|
@@ -195,20 +154,16 @@ files:
|
|
195
154
|
- lib/rdoc/generator/template/darkfish/images/zoom.png
|
196
155
|
- lib/rdoc/generator/template/darkfish/index.rhtml
|
197
156
|
- lib/rdoc/generator/template/darkfish/js/darkfish.js
|
198
|
-
- lib/rdoc/generator/template/darkfish/js/jquery.js
|
199
157
|
- lib/rdoc/generator/template/darkfish/js/search.js
|
200
158
|
- lib/rdoc/generator/template/darkfish/page.rhtml
|
201
159
|
- lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
|
202
160
|
- lib/rdoc/generator/template/darkfish/servlet_root.rhtml
|
203
161
|
- lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
|
204
|
-
- lib/rdoc/generator/template/json_index/.document
|
205
162
|
- lib/rdoc/generator/template/json_index/js/navigation.js
|
206
163
|
- lib/rdoc/generator/template/json_index/js/searcher.js
|
207
|
-
- lib/rdoc/ghost_method.rb
|
208
164
|
- lib/rdoc/i18n.rb
|
209
165
|
- lib/rdoc/i18n/locale.rb
|
210
166
|
- lib/rdoc/i18n/text.rb
|
211
|
-
- lib/rdoc/include.rb
|
212
167
|
- lib/rdoc/known_classes.rb
|
213
168
|
- lib/rdoc/markdown.kpeg
|
214
169
|
- lib/rdoc/markdown.rb
|
@@ -224,21 +179,19 @@ files:
|
|
224
179
|
- lib/rdoc/markup/block_quote.rb
|
225
180
|
- lib/rdoc/markup/document.rb
|
226
181
|
- lib/rdoc/markup/formatter.rb
|
227
|
-
- lib/rdoc/markup/formatter_test_case.rb
|
228
182
|
- lib/rdoc/markup/hard_break.rb
|
229
183
|
- lib/rdoc/markup/heading.rb
|
230
184
|
- lib/rdoc/markup/include.rb
|
231
185
|
- lib/rdoc/markup/indented_paragraph.rb
|
232
|
-
- lib/rdoc/markup/inline.rb
|
233
186
|
- lib/rdoc/markup/list.rb
|
234
187
|
- lib/rdoc/markup/list_item.rb
|
235
188
|
- lib/rdoc/markup/paragraph.rb
|
236
189
|
- lib/rdoc/markup/parser.rb
|
237
190
|
- lib/rdoc/markup/pre_process.rb
|
238
191
|
- lib/rdoc/markup/raw.rb
|
192
|
+
- lib/rdoc/markup/regexp_handling.rb
|
239
193
|
- lib/rdoc/markup/rule.rb
|
240
|
-
- lib/rdoc/markup/
|
241
|
-
- lib/rdoc/markup/text_formatter_test_case.rb
|
194
|
+
- lib/rdoc/markup/table.rb
|
242
195
|
- lib/rdoc/markup/to_ansi.rb
|
243
196
|
- lib/rdoc/markup/to_bs.rb
|
244
197
|
- lib/rdoc/markup/to_html.rb
|
@@ -252,17 +205,14 @@ files:
|
|
252
205
|
- lib/rdoc/markup/to_test.rb
|
253
206
|
- lib/rdoc/markup/to_tt_only.rb
|
254
207
|
- lib/rdoc/markup/verbatim.rb
|
255
|
-
- lib/rdoc/meta_method.rb
|
256
|
-
- lib/rdoc/method_attr.rb
|
257
|
-
- lib/rdoc/mixin.rb
|
258
|
-
- lib/rdoc/normal_class.rb
|
259
|
-
- lib/rdoc/normal_module.rb
|
260
208
|
- lib/rdoc/options.rb
|
261
209
|
- lib/rdoc/parser.rb
|
262
210
|
- lib/rdoc/parser/c.rb
|
263
211
|
- lib/rdoc/parser/changelog.rb
|
264
212
|
- lib/rdoc/parser/markdown.rb
|
213
|
+
- lib/rdoc/parser/prism_ruby.rb
|
265
214
|
- lib/rdoc/parser/rd.rb
|
215
|
+
- lib/rdoc/parser/ripper_state_lex.rb
|
266
216
|
- lib/rdoc/parser/ruby.rb
|
267
217
|
- lib/rdoc/parser/ruby_tools.rb
|
268
218
|
- lib/rdoc/parser/simple.rb
|
@@ -274,35 +224,33 @@ files:
|
|
274
224
|
- lib/rdoc/rd/inline_parser.rb
|
275
225
|
- lib/rdoc/rd/inline_parser.ry
|
276
226
|
- lib/rdoc/rdoc.rb
|
277
|
-
- lib/rdoc/require.rb
|
278
227
|
- lib/rdoc/ri.rb
|
279
228
|
- lib/rdoc/ri/driver.rb
|
280
229
|
- lib/rdoc/ri/formatter.rb
|
281
230
|
- lib/rdoc/ri/paths.rb
|
282
231
|
- lib/rdoc/ri/store.rb
|
283
232
|
- lib/rdoc/ri/task.rb
|
284
|
-
- lib/rdoc/ruby_lex.rb
|
285
|
-
- lib/rdoc/ruby_token.rb
|
286
233
|
- lib/rdoc/rubygems_hook.rb
|
287
234
|
- lib/rdoc/servlet.rb
|
288
|
-
- lib/rdoc/single_class.rb
|
289
235
|
- lib/rdoc/stats.rb
|
290
236
|
- lib/rdoc/stats/normal.rb
|
291
237
|
- lib/rdoc/stats/quiet.rb
|
292
238
|
- lib/rdoc/stats/verbose.rb
|
293
239
|
- lib/rdoc/store.rb
|
294
240
|
- lib/rdoc/task.rb
|
295
|
-
- lib/rdoc/test_case.rb
|
296
241
|
- lib/rdoc/text.rb
|
297
242
|
- lib/rdoc/token_stream.rb
|
298
243
|
- lib/rdoc/tom_doc.rb
|
299
|
-
- lib/rdoc/
|
300
|
-
-
|
301
|
-
|
244
|
+
- lib/rdoc/version.rb
|
245
|
+
- lib/rubygems_plugin.rb
|
246
|
+
- man/ri.1
|
247
|
+
homepage: https://ruby.github.io/rdoc
|
302
248
|
licenses:
|
303
249
|
- Ruby
|
304
|
-
metadata:
|
305
|
-
|
250
|
+
metadata:
|
251
|
+
homepage_uri: https://ruby.github.io/rdoc
|
252
|
+
source_code_uri: https://github.com/ruby/rdoc
|
253
|
+
changelog_uri: https://github.com/ruby/rdoc/releases
|
306
254
|
rdoc_options:
|
307
255
|
- "--main"
|
308
256
|
- README.rdoc
|
@@ -312,16 +260,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
312
260
|
requirements:
|
313
261
|
- - ">="
|
314
262
|
- !ruby/object:Gem::Version
|
315
|
-
version:
|
263
|
+
version: 2.6.0
|
316
264
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
317
265
|
requirements:
|
318
266
|
- - ">="
|
319
267
|
- !ruby/object:Gem::Version
|
320
268
|
version: '2.2'
|
321
269
|
requirements: []
|
322
|
-
|
323
|
-
rubygems_version: 2.6.10
|
324
|
-
signing_key:
|
270
|
+
rubygems_version: 3.6.2
|
325
271
|
specification_version: 4
|
326
272
|
summary: RDoc produces HTML and command-line documentation for Ruby projects
|
327
273
|
test_files: []
|
data/.document
DELETED
data/.gitignore
DELETED
data/.travis.yml
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
---
|
2
|
-
before_install:
|
3
|
-
- gem install bundler --no-document
|
4
|
-
language: ruby
|
5
|
-
notifications:
|
6
|
-
email:
|
7
|
-
- mail@zzak.io
|
8
|
-
rvm:
|
9
|
-
- 1.9.3
|
10
|
-
- 2.0.0
|
11
|
-
- 2.1.10
|
12
|
-
- 2.2.6
|
13
|
-
- 2.3.3
|
14
|
-
- 2.4.0
|
15
|
-
- ruby-head
|
16
|
-
- rbx-2
|
17
|
-
- jruby-1.7.25
|
18
|
-
- jruby-9.1.0.0
|
19
|
-
script: rake
|
20
|
-
matrix:
|
21
|
-
allow_failures:
|
22
|
-
- rvm: jruby-1.7.25
|
23
|
-
- rvm: jruby-9.1.0.0
|
24
|
-
- rvm: rbx-2
|
data/Gemfile
DELETED
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
|
-
|
data/Rakefile
DELETED
@@ -1,133 +0,0 @@
|
|
1
|
-
$:.unshift File.expand_path 'lib'
|
2
|
-
require 'rdoc/task'
|
3
|
-
require 'bundler/gem_tasks'
|
4
|
-
require 'rake/testtask'
|
5
|
-
|
6
|
-
ENV['BENCHMARK'] = 'yes'
|
7
|
-
|
8
|
-
task :docs => :generate
|
9
|
-
task :test => :generate
|
10
|
-
|
11
|
-
PARSER_FILES = %w[
|
12
|
-
lib/rdoc/rd/block_parser.ry
|
13
|
-
lib/rdoc/rd/inline_parser.ry
|
14
|
-
lib/rdoc/markdown.kpeg
|
15
|
-
lib/rdoc/markdown/literals.kpeg
|
16
|
-
]
|
17
|
-
|
18
|
-
$rdoc_rakefile = true
|
19
|
-
|
20
|
-
task :default => :test
|
21
|
-
|
22
|
-
RDoc::Task.new do |doc|
|
23
|
-
doc.main = 'README.rdoc'
|
24
|
-
doc.title = "rdoc #{RDoc::VERSION} Documentation"
|
25
|
-
doc.rdoc_dir = 'html'
|
26
|
-
doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc] - PARSER_FILES
|
27
|
-
end
|
28
|
-
|
29
|
-
task ghpages: :rdoc do
|
30
|
-
`git checkout gh-pages`
|
31
|
-
require "fileutils"
|
32
|
-
FileUtils.rm_rf "/tmp/html"
|
33
|
-
FileUtils.mv "html", "/tmp"
|
34
|
-
FileUtils.rm_rf "*"
|
35
|
-
FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
|
36
|
-
end
|
37
|
-
|
38
|
-
Rake::TestTask.new(:test) do |t|
|
39
|
-
t.libs << "test"
|
40
|
-
t.libs << "lib"
|
41
|
-
t.test_files = FileList['test/**/test_*.rb']
|
42
|
-
end
|
43
|
-
|
44
|
-
path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
|
45
|
-
|
46
|
-
package_parser_files = PARSER_FILES.map do |parser_file|
|
47
|
-
name = File.basename(parser_file, File.extname(parser_file))
|
48
|
-
_path = File.dirname(parser_file)
|
49
|
-
package_parser_file = "#{path}/#{name}.rb"
|
50
|
-
parsed_file = "#{_path}/#{name}.rb"
|
51
|
-
|
52
|
-
file package_parser_file => parsed_file # ensure copy runs before racc
|
53
|
-
|
54
|
-
package_parser_file
|
55
|
-
end
|
56
|
-
|
57
|
-
parsed_files = PARSER_FILES.map do |parser_file|
|
58
|
-
name = File.basename(parser_file, File.extname(parser_file))
|
59
|
-
_path = File.dirname(parser_file)
|
60
|
-
parsed_file = "#{_path}/#{name}.rb"
|
61
|
-
|
62
|
-
file parsed_file do |t|
|
63
|
-
puts "Generating #{parsed_file}..."
|
64
|
-
if parser_file =~ /\.ry\z/ # need racc
|
65
|
-
racc = Gem.bin_path 'racc', 'racc'
|
66
|
-
rb_file = parser_file.gsub(/\.ry\z/, ".rb")
|
67
|
-
ruby "-rubygems #{racc} -l -o #{rb_file} #{parser_file}"
|
68
|
-
elsif parser_file =~ /\.kpeg\z/ # need kpeg
|
69
|
-
kpeg = Gem.bin_path 'kpeg', 'kpeg'
|
70
|
-
rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
|
71
|
-
ruby "-rubygems #{kpeg} -fsv -o #{rb_file} #{parser_file}"
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
|
-
parsed_file
|
76
|
-
end
|
77
|
-
|
78
|
-
task "#{path}.gem" => package_parser_files
|
79
|
-
task :generate => parsed_files
|
80
|
-
task :check_manifest => :generate
|
81
|
-
|
82
|
-
# These tasks expect to have the following directory structure:
|
83
|
-
#
|
84
|
-
# git/git.rubini.us/code # Rubinius git HEAD checkout
|
85
|
-
# svn/ruby/trunk # ruby subversion HEAD checkout
|
86
|
-
# svn/rdoc/trunk # RDoc subversion HEAD checkout
|
87
|
-
#
|
88
|
-
# If you don't have this directory structure, set RUBY_PATH and/or
|
89
|
-
# RUBINIUS_PATH.
|
90
|
-
|
91
|
-
diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
|
92
|
-
rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig' --exclude '*.kpeg' --exclude '*.ry' --exclude 'literals_1_8.rb' --exclude 'gauntlet_rdoc.rb'"
|
93
|
-
|
94
|
-
rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
|
95
|
-
ruby_dir = ENV['RUBY_PATH'] || '../../svn/ruby/trunk'
|
96
|
-
|
97
|
-
desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
|
98
|
-
task :update_ruby do
|
99
|
-
sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
|
100
|
-
sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
|
101
|
-
sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
|
102
|
-
sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
|
103
|
-
end
|
104
|
-
|
105
|
-
desc "Diffs Ruby HEAD with the currently checked-out copy of RDoc."
|
106
|
-
task :diff_ruby do
|
107
|
-
options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
|
108
|
-
|
109
|
-
sh "diff #{diff_options} bin/rdoc #{ruby_dir}/bin/rdoc; true"
|
110
|
-
sh "diff #{diff_options} bin/ri #{ruby_dir}/bin/ri; true"
|
111
|
-
sh "diff #{diff_options} lib/rdoc.rb #{ruby_dir}/lib/rdoc.rb; true"
|
112
|
-
sh "diff #{diff_options} lib/rdoc #{ruby_dir}/lib/rdoc; true"
|
113
|
-
sh "diff #{diff_options} test #{ruby_dir}/test/rdoc; true"
|
114
|
-
end
|
115
|
-
|
116
|
-
desc "Updates Rubinius HEAD with the currently checked-out copy of RDoc."
|
117
|
-
task :update_rubinius do
|
118
|
-
sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
|
119
|
-
sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
|
120
|
-
sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
|
121
|
-
sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
|
122
|
-
end
|
123
|
-
|
124
|
-
desc "Diffs Rubinius HEAD with the currently checked-out copy of RDoc."
|
125
|
-
task :diff_rubinius do
|
126
|
-
sh "diff #{diff_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb; true"
|
127
|
-
sh "diff #{diff_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb; true"
|
128
|
-
sh "diff #{diff_options} lib/rdoc.rb #{rubinius_dir}/lib/rdoc.rb; true"
|
129
|
-
sh "diff #{diff_options} lib/rdoc #{rubinius_dir}/lib/rdoc; true"
|
130
|
-
sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
|
131
|
-
end
|
132
|
-
|
133
|
-
task :build => [:generate]
|
data/bin/console
DELETED
data/bin/setup
DELETED
data/lib/gauntlet_rdoc.rb
DELETED
@@ -1,82 +0,0 @@
|
|
1
|
-
Gem.load_yaml
|
2
|
-
require 'rdoc'
|
3
|
-
require 'gauntlet'
|
4
|
-
require 'fileutils'
|
5
|
-
|
6
|
-
##
|
7
|
-
# Allows for testing of RDoc against every gem
|
8
|
-
|
9
|
-
class RDoc::Gauntlet < Gauntlet
|
10
|
-
|
11
|
-
def initialize # :nodoc:
|
12
|
-
super
|
13
|
-
|
14
|
-
@args = nil
|
15
|
-
@type = nil
|
16
|
-
end
|
17
|
-
|
18
|
-
##
|
19
|
-
# Runs an RDoc generator for gem +name+
|
20
|
-
|
21
|
-
def run name
|
22
|
-
return if self.data.key? name
|
23
|
-
|
24
|
-
dir = File.expand_path "~/.gauntlet/data/#{@type}/#{name}"
|
25
|
-
FileUtils.rm_rf dir if File.exist? dir
|
26
|
-
|
27
|
-
yaml = File.read 'gemspec'
|
28
|
-
begin
|
29
|
-
spec = Gem::Specification.from_yaml yaml
|
30
|
-
rescue Psych::SyntaxError
|
31
|
-
puts "bad spec #{name}"
|
32
|
-
self.data[name] = false
|
33
|
-
return
|
34
|
-
end
|
35
|
-
|
36
|
-
args = @args.dup
|
37
|
-
args << '--op' << dir
|
38
|
-
args.concat spec.rdoc_options
|
39
|
-
args << spec.require_paths
|
40
|
-
args << spec.extra_rdoc_files
|
41
|
-
args = args.flatten.map { |a| a.to_s }
|
42
|
-
args.delete '--quiet'
|
43
|
-
|
44
|
-
puts "#{name} - rdoc #{args.join ' '}"
|
45
|
-
|
46
|
-
self.dirty = true
|
47
|
-
r = RDoc::RDoc.new
|
48
|
-
|
49
|
-
begin
|
50
|
-
r.document args
|
51
|
-
self.data[name] = true
|
52
|
-
puts 'passed'
|
53
|
-
FileUtils.rm_rf dir
|
54
|
-
rescue Interrupt, StandardError, RDoc::Error, SystemStackError => e
|
55
|
-
puts "failed - (#{e.class}) #{e.message}"
|
56
|
-
self.data[name] = false
|
57
|
-
end
|
58
|
-
rescue Gem::Exception
|
59
|
-
puts "bad gem #{name}"
|
60
|
-
ensure
|
61
|
-
puts
|
62
|
-
end
|
63
|
-
|
64
|
-
##
|
65
|
-
# Runs the gauntlet with the given +type+ (rdoc or ri) and +filter+ for
|
66
|
-
# which gems to run
|
67
|
-
|
68
|
-
def run_the_gauntlet type = 'rdoc', filter = nil
|
69
|
-
@type = type || 'rdoc'
|
70
|
-
@args = type == 'rdoc' ? [] : %w[--ri]
|
71
|
-
@data_file = "#{DATADIR}/#{@type}-data.yml"
|
72
|
-
|
73
|
-
super filter
|
74
|
-
end
|
75
|
-
|
76
|
-
end
|
77
|
-
|
78
|
-
type = ARGV.shift
|
79
|
-
filter = ARGV.shift
|
80
|
-
filter = /#{filter}/ if filter
|
81
|
-
|
82
|
-
RDoc::Gauntlet.new.run_the_gauntlet type, filter
|
File without changes
|
@@ -1,19 +0,0 @@
|
|
1
|
-
<% if !svninfo.empty? then %>
|
2
|
-
<div id="file-svninfo-section" class="nav-section">
|
3
|
-
<h3>VCS Info</h3>
|
4
|
-
|
5
|
-
<div class="section-body">
|
6
|
-
<dl class="svninfo">
|
7
|
-
<dt>Rev
|
8
|
-
<dd><%= svninfo[:rev] %>
|
9
|
-
|
10
|
-
<dt>Last Checked In
|
11
|
-
<dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
|
12
|
-
(<%= svninfo[:commitdelta] %> ago)
|
13
|
-
|
14
|
-
<dt>Checked in by
|
15
|
-
<dd><%= svninfo[:committer] %>
|
16
|
-
</dl>
|
17
|
-
</div>
|
18
|
-
</div>
|
19
|
-
<% end %>
|