rdoc 6.7.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.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/ExampleMarkdown.md +2 -0
  3. data/ExampleRDoc.rdoc +2 -0
  4. data/History.rdoc +64 -62
  5. data/LICENSE.rdoc +2 -0
  6. data/README.rdoc +13 -0
  7. data/RI.md +842 -0
  8. data/TODO.rdoc +8 -7
  9. data/lib/rdoc/{alias.rb → code_object/alias.rb} +3 -10
  10. data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +7 -12
  11. data/lib/rdoc/{attr.rb → code_object/attr.rb} +4 -7
  12. data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +107 -20
  13. data/lib/rdoc/{constant.rb → code_object/constant.rb} +1 -1
  14. data/lib/rdoc/{context → code_object/context}/section.rb +10 -68
  15. data/lib/rdoc/{context.rb → code_object/context.rb} +4 -46
  16. data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +19 -27
  17. data/lib/rdoc/{require.rb → code_object/require.rb} +1 -1
  18. data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +10 -28
  19. data/lib/rdoc/code_object.rb +6 -32
  20. data/lib/rdoc/comment.rb +12 -5
  21. data/lib/rdoc/generator/darkfish.rb +121 -95
  22. data/lib/rdoc/generator/json_index.rb +1 -17
  23. data/lib/rdoc/generator/markup.rb +2 -2
  24. data/lib/rdoc/generator/pot/message_extractor.rb +3 -3
  25. data/lib/rdoc/generator/pot/po_entry.rb +1 -1
  26. data/lib/rdoc/generator/pot.rb +0 -5
  27. data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
  28. data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +1 -29
  29. data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +1 -1
  30. data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +1 -1
  31. data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
  32. data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
  33. data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
  34. data/lib/rdoc/generator/template/darkfish/class.rhtml +84 -43
  35. data/lib/rdoc/generator/template/darkfish/css/rdoc.css +391 -397
  36. data/lib/rdoc/generator/template/darkfish/index.rhtml +11 -10
  37. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +24 -1
  38. data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
  39. data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
  40. data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
  41. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
  42. data/lib/rdoc/markdown.kpeg +8 -6
  43. data/lib/rdoc/markdown.rb +55 -32
  44. data/lib/rdoc/markup/attribute_manager.rb +2 -2
  45. data/lib/rdoc/markup/formatter.rb +19 -12
  46. data/lib/rdoc/markup/heading.rb +7 -1
  47. data/lib/rdoc/markup/pre_process.rb +26 -6
  48. data/lib/rdoc/markup/to_bs.rb +1 -1
  49. data/lib/rdoc/markup/to_html.rb +7 -2
  50. data/lib/rdoc/markup/to_html_crossref.rb +63 -12
  51. data/lib/rdoc/markup/to_rdoc.rb +5 -5
  52. data/lib/rdoc/markup.rb +18 -13
  53. data/lib/rdoc/options.rb +90 -12
  54. data/lib/rdoc/parser/c.rb +30 -9
  55. data/lib/rdoc/parser/changelog.rb +5 -4
  56. data/lib/rdoc/parser/prism_ruby.rb +1092 -0
  57. data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
  58. data/lib/rdoc/parser/ruby.rb +23 -17
  59. data/lib/rdoc/parser/simple.rb +1 -1
  60. data/lib/rdoc/parser.rb +5 -4
  61. data/lib/rdoc/rd/block_parser.rb +3 -3
  62. data/lib/rdoc/rd/inline_parser.rb +3 -3
  63. data/lib/rdoc/rdoc.rb +9 -21
  64. data/lib/rdoc/ri/driver.rb +85 -32
  65. data/lib/rdoc/rubygems_hook.rb +91 -15
  66. data/lib/rdoc/servlet.rb +8 -7
  67. data/lib/rdoc/stats.rb +2 -2
  68. data/lib/rdoc/store.rb +21 -13
  69. data/lib/rdoc/task.rb +2 -3
  70. data/lib/rdoc/text.rb +2 -2
  71. data/lib/rdoc/tom_doc.rb +1 -7
  72. data/lib/rdoc/version.rb +1 -1
  73. data/lib/rdoc.rb +22 -24
  74. data/lib/rubygems_plugin.rb +23 -0
  75. metadata +27 -28
  76. data/RI.rdoc +0 -57
  77. data/lib/rdoc/generator/template/darkfish/.document +0 -0
  78. data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +0 -19
  79. data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +0 -9
  80. data/lib/rdoc/generator/template/json_index/.document +0 -1
  81. /data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
  82. /data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
  83. /data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
  84. /data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
  85. /data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
  86. /data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
  87. /data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
  88. /data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
  89. /data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ # If this file is exist, RDoc generates and removes documents by rubygems plugins.
4
+ #
5
+ # In follwing cases,
6
+ # RubyGems directly exectute RDoc::RubygemsHook.generation_hook and RDoc::RubygemsHook#remove to generate and remove documents.
7
+ #
8
+ # - RDoc is used as a default gem.
9
+ # - RDoc is a old version that doesn't have rubygems_plugin.rb.
10
+
11
+ require_relative 'rdoc/rubygems_hook'
12
+
13
+ # To install dependency libraries of RDoc, you need to run bundle install.
14
+ # At that time, rdoc/markdown is not generated.
15
+ # If generate and remove are executed at that time, an error will occur.
16
+ # So, we can't register generate and remove to Gem at that time.
17
+ begin
18
+ require_relative 'rdoc/markdown'
19
+ rescue LoadError
20
+ else
21
+ Gem.done_installing(&RDoc::RubyGemsHook.method(:generate))
22
+ Gem.pre_uninstall(&RDoc::RubyGemsHook.method(:remove))
23
+ end
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.7.0
4
+ version: 6.13.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Eric Hodel
@@ -13,7 +13,7 @@ authors:
13
13
  - ITOYANAGI Sakura
14
14
  bindir: exe
15
15
  cert_chain: []
16
- date: 2024-05-23 00:00:00.000000000 Z
16
+ date: 2025-03-29 00:00:00.000000000 Z
17
17
  dependencies:
18
18
  - !ruby/object:Gem::Dependency
19
19
  name: psych
@@ -53,7 +53,7 @@ extra_rdoc_files:
53
53
  - LEGAL.rdoc
54
54
  - LICENSE.rdoc
55
55
  - README.rdoc
56
- - RI.rdoc
56
+ - RI.md
57
57
  - TODO.rdoc
58
58
  files:
59
59
  - CONTRIBUTING.rdoc
@@ -64,27 +64,37 @@ files:
64
64
  - LEGAL.rdoc
65
65
  - LICENSE.rdoc
66
66
  - README.rdoc
67
- - RI.rdoc
67
+ - RI.md
68
68
  - TODO.rdoc
69
69
  - exe/rdoc
70
70
  - exe/ri
71
71
  - 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
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
78
92
  - lib/rdoc/code_objects.rb
79
93
  - lib/rdoc/comment.rb
80
- - lib/rdoc/constant.rb
81
- - lib/rdoc/context.rb
82
- - lib/rdoc/context/section.rb
83
94
  - lib/rdoc/cross_reference.rb
84
95
  - lib/rdoc/encoding.rb
85
96
  - lib/rdoc/erb_partial.rb
86
97
  - lib/rdoc/erbio.rb
87
- - lib/rdoc/extend.rb
88
98
  - lib/rdoc/generator.rb
89
99
  - lib/rdoc/generator/darkfish.rb
90
100
  - lib/rdoc/generator/json_index.rb
@@ -94,13 +104,10 @@ files:
94
104
  - lib/rdoc/generator/pot/po.rb
95
105
  - lib/rdoc/generator/pot/po_entry.rb
96
106
  - lib/rdoc/generator/ri.rb
97
- - lib/rdoc/generator/template/darkfish/.document
98
107
  - lib/rdoc/generator/template/darkfish/_footer.rhtml
99
108
  - lib/rdoc/generator/template/darkfish/_head.rhtml
100
- - lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
101
109
  - lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
102
110
  - lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml
103
- - lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
104
111
  - lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
105
112
  - lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml
106
113
  - lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
@@ -110,6 +117,7 @@ files:
110
117
  - lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
111
118
  - lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
112
119
  - lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
120
+ - lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml
113
121
  - lib/rdoc/generator/template/darkfish/class.rhtml
114
122
  - lib/rdoc/generator/template/darkfish/css/fonts.css
115
123
  - lib/rdoc/generator/template/darkfish/css/rdoc.css
@@ -151,14 +159,11 @@ files:
151
159
  - lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
152
160
  - lib/rdoc/generator/template/darkfish/servlet_root.rhtml
153
161
  - lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
154
- - lib/rdoc/generator/template/json_index/.document
155
162
  - lib/rdoc/generator/template/json_index/js/navigation.js
156
163
  - lib/rdoc/generator/template/json_index/js/searcher.js
157
- - lib/rdoc/ghost_method.rb
158
164
  - lib/rdoc/i18n.rb
159
165
  - lib/rdoc/i18n/locale.rb
160
166
  - lib/rdoc/i18n/text.rb
161
- - lib/rdoc/include.rb
162
167
  - lib/rdoc/known_classes.rb
163
168
  - lib/rdoc/markdown.kpeg
164
169
  - lib/rdoc/markdown.rb
@@ -200,16 +205,12 @@ files:
200
205
  - lib/rdoc/markup/to_test.rb
201
206
  - lib/rdoc/markup/to_tt_only.rb
202
207
  - 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
208
  - lib/rdoc/options.rb
209
209
  - lib/rdoc/parser.rb
210
210
  - lib/rdoc/parser/c.rb
211
211
  - lib/rdoc/parser/changelog.rb
212
212
  - lib/rdoc/parser/markdown.rb
213
+ - lib/rdoc/parser/prism_ruby.rb
213
214
  - lib/rdoc/parser/rd.rb
214
215
  - lib/rdoc/parser/ripper_state_lex.rb
215
216
  - lib/rdoc/parser/ruby.rb
@@ -223,7 +224,6 @@ files:
223
224
  - lib/rdoc/rd/inline_parser.rb
224
225
  - lib/rdoc/rd/inline_parser.ry
225
226
  - lib/rdoc/rdoc.rb
226
- - lib/rdoc/require.rb
227
227
  - lib/rdoc/ri.rb
228
228
  - lib/rdoc/ri/driver.rb
229
229
  - lib/rdoc/ri/formatter.rb
@@ -232,7 +232,6 @@ files:
232
232
  - lib/rdoc/ri/task.rb
233
233
  - lib/rdoc/rubygems_hook.rb
234
234
  - lib/rdoc/servlet.rb
235
- - lib/rdoc/single_class.rb
236
235
  - lib/rdoc/stats.rb
237
236
  - lib/rdoc/stats/normal.rb
238
237
  - lib/rdoc/stats/quiet.rb
@@ -242,8 +241,8 @@ files:
242
241
  - lib/rdoc/text.rb
243
242
  - lib/rdoc/token_stream.rb
244
243
  - lib/rdoc/tom_doc.rb
245
- - lib/rdoc/top_level.rb
246
244
  - lib/rdoc/version.rb
245
+ - lib/rubygems_plugin.rb
247
246
  - man/ri.1
248
247
  homepage: https://ruby.github.io/rdoc
249
248
  licenses:
@@ -268,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
268
267
  - !ruby/object:Gem::Version
269
268
  version: '2.2'
270
269
  requirements: []
271
- rubygems_version: 3.6.0.dev
270
+ rubygems_version: 3.6.2
272
271
  specification_version: 4
273
272
  summary: RDoc produces HTML and command-line documentation for Ruby projects
274
273
  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
@@ -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 -%>
@@ -1,9 +0,0 @@
1
- <div id="file-list-section" class="nav-section">
2
- <h3>Defined In</h3>
3
-
4
- <ul>
5
- <%- klass.in_files.each do |tl| -%>
6
- <li><%= h tl.relative_name %>
7
- <%- end -%>
8
- </ul>
9
- </div>
@@ -1 +0,0 @@
1
- # ignore all files in this directory
File without changes
File without changes
File without changes