Merge branch 'master' into ruby-docs

Author: alexisbernard

.github/workflows/test.yml

@@ -53,6 +53,8 @@ jobs:
         RDOC_USE_PRISM_PARSER: true
     - if: ${{ matrix.ruby == 'head' && startsWith(matrix.os, 'ubuntu') }}
       run: bundle exec rake rdoc
+    - if: ${{ matrix.ruby == 'head' && startsWith(matrix.os, 'ubuntu') }}
+      run: bundle exec rake install
   lint:
     runs-on: ubuntu-latest
     steps:

doc/rdoc/markup_reference.rb

@@ -918,10 +918,6 @@
 #
 #   - Linked: <tt>https://github.com</tt> links to https://github.com.
 #
-# [Protocol +www+]
-#
-#   - Linked: <tt>www.yahoo.com</tt> links to www.yahoo.com.
-#
 # [Protocol +ftp+]
 #
 #   - Linked: <tt>ftp://nosuch.site</tt> links to ftp://nosuch.site.

lib/rdoc.rb

@@ -21,7 +21,7 @@
 # see RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.
 #
 # If you want to set the default markup format see
-# RDoc::Markup@Supported+Formats
+# RDoc::Markup@Markup+Formats
 #
 # If you want to store rdoc configuration in your gem (such as the default
 # markup format) see RDoc::Options@Saved+Options

lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -223,6 +223,7 @@ nav a:hover {
   position: fixed;
   top: 10px;
   left: 20px;
+  cursor: pointer;
 }
 
 #navigation-toggle[aria-expanded="true"] {
@@ -307,7 +308,7 @@ main h6 {
 
 #search-field {
   width: 100%;
-  padding: 0.5em 1em 0.5em 2em;
+  padding: 0.5em 1em 0.5em 2.5em;
   border: 1px solid var(--border-color);
   border-radius: 20px;
   font-size: 14px;

lib/rdoc/rdoc.rb

@@ -520,6 +520,7 @@ def generate
       Dir.chdir @options.op_dir do
         unless @options.quiet then
           $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
+          $stderr.puts "\nYou can visit the home page at: \e]8;;file://#{Dir.pwd}/index.html\e\\file://#{Dir.pwd}/index.html\e]8;;\e\\"
         end
 
         @generator.generate

rdoc.gemspec

@@ -46,27 +46,27 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "LEGAL.rdoc",
     "LICENSE.rdoc",
     "README.rdoc",
-    "RI.rdoc",
+    "RI.md",
     "TODO.rdoc",
     "exe/rdoc",
     "exe/ri",
     "lib/rdoc.rb",
-    "lib/rdoc/alias.rb",
-    "lib/rdoc/anon_class.rb",
-    "lib/rdoc/any_method.rb",
-    "lib/rdoc/attr.rb",
-    "lib/rdoc/class_module.rb",
+    "lib/rdoc/code_object/alias.rb",
+    "lib/rdoc/code_object/anon_class.rb",
+    "lib/rdoc/code_object/any_method.rb",
+    "lib/rdoc/code_object/attr.rb",
+    "lib/rdoc/code_object/class_module.rb",
     "lib/rdoc/code_object.rb",
     "lib/rdoc/code_objects.rb",
     "lib/rdoc/comment.rb",
-    "lib/rdoc/constant.rb",
-    "lib/rdoc/context.rb",
-    "lib/rdoc/context/section.rb",
+    "lib/rdoc/code_object/constant.rb",
+    "lib/rdoc/code_object/context.rb",
+    "lib/rdoc/code_object/context/section.rb",
     "lib/rdoc/cross_reference.rb",
     "lib/rdoc/encoding.rb",
     "lib/rdoc/erb_partial.rb",
     "lib/rdoc/erbio.rb",
-    "lib/rdoc/extend.rb",
+    "lib/rdoc/code_object/extend.rb",
     "lib/rdoc/generator.rb",
     "lib/rdoc/generator/darkfish.rb",
     "lib/rdoc/generator/json_index.rb",
@@ -136,11 +136,11 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "lib/rdoc/generator/template/json_index/.document",
     "lib/rdoc/generator/template/json_index/js/navigation.js",
     "lib/rdoc/generator/template/json_index/js/searcher.js",
-    "lib/rdoc/ghost_method.rb",
+    "lib/rdoc/code_object/ghost_method.rb",
     "lib/rdoc/i18n.rb",
     "lib/rdoc/i18n/locale.rb",
     "lib/rdoc/i18n/text.rb",
-    "lib/rdoc/include.rb",
+    "lib/rdoc/code_object/include.rb",
     "lib/rdoc/known_classes.rb",
     "lib/rdoc/markdown.kpeg",
     "lib/rdoc/markdown/entities.rb",
@@ -180,11 +180,11 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "lib/rdoc/markup/to_test.rb",
     "lib/rdoc/markup/to_tt_only.rb",
     "lib/rdoc/markup/verbatim.rb",
-    "lib/rdoc/meta_method.rb",
-    "lib/rdoc/method_attr.rb",
-    "lib/rdoc/mixin.rb",
-    "lib/rdoc/normal_class.rb",
-    "lib/rdoc/normal_module.rb",
+    "lib/rdoc/code_object/meta_method.rb",
+    "lib/rdoc/code_object/method_attr.rb",
+    "lib/rdoc/code_object/mixin.rb",
+    "lib/rdoc/code_object/normal_class.rb",
+    "lib/rdoc/code_object/normal_module.rb",
     "lib/rdoc/options.rb",
     "lib/rdoc/parser.rb",
     "lib/rdoc/parser/c.rb",
@@ -201,7 +201,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "lib/rdoc/rd/inline.rb",
     "lib/rdoc/rd/inline_parser.ry",
     "lib/rdoc/rdoc.rb",
-    "lib/rdoc/require.rb",
+    "lib/rdoc/code_object/require.rb",
     "lib/rdoc/ri.rb",
     "lib/rdoc/ri/driver.rb",
     "lib/rdoc/ri/formatter.rb",
@@ -210,7 +210,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "lib/rdoc/ri/task.rb",
     "lib/rdoc/rubygems_hook.rb",
     "lib/rdoc/servlet.rb",
-    "lib/rdoc/single_class.rb",
+    "lib/rdoc/code_object/single_class.rb",
     "lib/rdoc/stats.rb",
     "lib/rdoc/stats/normal.rb",
     "lib/rdoc/stats/quiet.rb",
@@ -220,7 +220,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
     "lib/rdoc/text.rb",
     "lib/rdoc/token_stream.rb",
     "lib/rdoc/tom_doc.rb",
-    "lib/rdoc/top_level.rb",
+    "lib/rdoc/code_object/top_level.rb",
     "lib/rdoc/version.rb",
     "man/ri.1",
   ]