rdoc 6.3.4.1 → 8.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.3.4.1
+  version: 8.0.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,22 +13,64 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2026-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gettext
+  name: erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: |
   RDoc produces HTML and command-line documentation for Ruby projects.
   RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
@@ -45,51 +87,53 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- CONTRIBUTING.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
-- RI.rdoc
+- README.md
+- RI.md
 - TODO.rdoc
 files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
-- ExampleMarkdown.md
-- ExampleRDoc.rdoc
-- Gemfile
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
-- RI.rdoc
-- Rakefile
+- README.md
+- RI.md
 - TODO.rdoc
-- bin/console
-- bin/setup
+- doc/markup_reference/markdown.md
+- doc/markup_reference/rdoc.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.rb
+- lib/rdoc/code_object/alias.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/constant.rb
+- lib/rdoc/code_object/context.rb
+- lib/rdoc/code_object/context/section.rb
+- lib/rdoc/code_object/extend.rb
+- lib/rdoc/code_object/include.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/code_object/require.rb
+- lib/rdoc/code_object/single_class.rb
+- lib/rdoc/code_object/top_level.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/cross_reference.rb
 - lib/rdoc/encoding.rb
 - lib/rdoc/erb_partial.rb
 - lib/rdoc/erbio.rb
-- lib/rdoc/extend.rb
 - lib/rdoc/generator.rb
+- lib/rdoc/generator/aliki.rb
 - lib/rdoc/generator/darkfish.rb
 - lib/rdoc/generator/json_index.rb
 - lib/rdoc/generator/markup.rb
@@ -98,13 +142,39 @@ files:
 - lib/rdoc/generator/pot/po.rb
 - lib/rdoc/generator/pot/po_entry.rb
 - lib/rdoc/generator/ri.rb
-- lib/rdoc/generator/template/darkfish/.document
+- lib/rdoc/generator/template/aliki/DESIGN.md
+- lib/rdoc/generator/template/aliki/_aside_toc.rhtml
+- lib/rdoc/generator/template/aliki/_footer.rhtml
+- lib/rdoc/generator/template/aliki/_head.rhtml
+- lib/rdoc/generator/template/aliki/_header.rhtml
+- lib/rdoc/generator/template/aliki/_icons.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_search.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml
+- lib/rdoc/generator/template/aliki/class.rhtml
+- lib/rdoc/generator/template/aliki/css/rdoc.css
+- lib/rdoc/generator/template/aliki/index.rhtml
+- lib/rdoc/generator/template/aliki/js/aliki.js
+- lib/rdoc/generator/template/aliki/js/bash_highlighter.js
+- lib/rdoc/generator/template/aliki/js/c_highlighter.js
+- lib/rdoc/generator/template/aliki/js/search_controller.js
+- lib/rdoc/generator/template/aliki/js/search_navigation.js
+- lib/rdoc/generator/template/aliki/js/search_ranker.js
+- lib/rdoc/generator/template/aliki/js/theme-toggle.js
+- lib/rdoc/generator/template/aliki/page.rhtml
+- lib/rdoc/generator/template/aliki/servlet_not_found.rhtml
+- lib/rdoc/generator/template/aliki/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/_footer.rhtml
 - lib/rdoc/generator/template/darkfish/_head.rhtml
-- lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml
-- lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
@@ -114,6 +184,7 @@ files:
 - lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
+- lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml
 - lib/rdoc/generator/template/darkfish/class.rhtml
 - lib/rdoc/generator/template/darkfish/css/fonts.css
 - lib/rdoc/generator/template/darkfish/css/rdoc.css
@@ -155,14 +226,11 @@ files:
 - lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
 - lib/rdoc/generator/template/darkfish/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
-- 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/i18n.rb
 - lib/rdoc/i18n/locale.rb
 - lib/rdoc/i18n/text.rb
-- lib/rdoc/include.rb
 - lib/rdoc/known_classes.rb
 - lib/rdoc/markdown.kpeg
 - lib/rdoc/markdown.rb
@@ -170,25 +238,22 @@ files:
 - lib/rdoc/markdown/literals.kpeg
 - lib/rdoc/markdown/literals.rb
 - lib/rdoc/markup.rb
-- lib/rdoc/markup/attr_changer.rb
-- lib/rdoc/markup/attr_span.rb
-- lib/rdoc/markup/attribute_manager.rb
-- lib/rdoc/markup/attributes.rb
 - lib/rdoc/markup/blank_line.rb
 - lib/rdoc/markup/block_quote.rb
 - lib/rdoc/markup/document.rb
+- lib/rdoc/markup/element.rb
 - lib/rdoc/markup/formatter.rb
 - lib/rdoc/markup/hard_break.rb
 - lib/rdoc/markup/heading.rb
 - lib/rdoc/markup/include.rb
 - lib/rdoc/markup/indented_paragraph.rb
+- lib/rdoc/markup/inline_parser.rb
 - lib/rdoc/markup/list.rb
 - lib/rdoc/markup/list_item.rb
 - lib/rdoc/markup/paragraph.rb
 - lib/rdoc/markup/parser.rb
 - lib/rdoc/markup/pre_process.rb
 - lib/rdoc/markup/raw.rb
-- lib/rdoc/markup/regexp_handling.rb
 - lib/rdoc/markup/rule.rb
 - lib/rdoc/markup/table.rb
 - lib/rdoc/markup/to_ansi.rb
@@ -204,22 +269,18 @@ files:
 - 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/options.rb
 - lib/rdoc/parser.rb
 - lib/rdoc/parser/c.rb
 - lib/rdoc/parser/changelog.rb
 - lib/rdoc/parser/markdown.rb
+- lib/rdoc/parser/rbs.rb
 - lib/rdoc/parser/rd.rb
-- lib/rdoc/parser/ripper_state_lex.rb
 - lib/rdoc/parser/ruby.rb
-- lib/rdoc/parser/ruby_tools.rb
+- lib/rdoc/parser/ruby_colorizer.rb
 - lib/rdoc/parser/simple.rb
 - lib/rdoc/parser/text.rb
+- lib/rdoc/rbs_helper.rb
 - lib/rdoc/rd.rb
 - lib/rdoc/rd/block_parser.rb
 - lib/rdoc/rd/block_parser.ry
@@ -227,16 +288,15 @@ files:
 - lib/rdoc/rd/inline_parser.rb
 - lib/rdoc/rd/inline_parser.ry
 - lib/rdoc/rdoc.rb
-- lib/rdoc/require.rb
 - lib/rdoc/ri.rb
 - lib/rdoc/ri/driver.rb
 - lib/rdoc/ri/formatter.rb
 - lib/rdoc/ri/paths.rb
+- lib/rdoc/ri/servlet.rb
 - lib/rdoc/ri/store.rb
 - lib/rdoc/ri/task.rb
 - lib/rdoc/rubygems_hook.rb
-- lib/rdoc/servlet.rb
-- lib/rdoc/single_class.rb
+- lib/rdoc/server.rb
 - lib/rdoc/stats.rb
 - lib/rdoc/stats/normal.rb
 - lib/rdoc/stats/quiet.rb
@@ -246,31 +306,38 @@ files:
 - lib/rdoc/text.rb
 - lib/rdoc/token_stream.rb
 - lib/rdoc/tom_doc.rb
-- lib/rdoc/top_level.rb
 - lib/rdoc/version.rb
+- lib/rubygems_plugin.rb
 - man/ri.1
+- rdoc-logo.svg
 - rdoc.gemspec
 homepage: https://ruby.github.io/rdoc
 licenses:
 - Ruby
-metadata: {}
+- GPL-2.0-only
+metadata:
+  homepage_uri: https://ruby.github.io/rdoc
+  source_code_uri: https://github.com/ruby/rdoc
+  changelog_uri: https://github.com/ruby/rdoc/releases
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
+- "--copy-files"
+- rdoc-logo.svg
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 4.0.10
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/CONTRIBUTING.rdoc

@@ -1,220 +0,0 @@
-= Developer Introduction
-
-So you want to write a generator, fix a bug, or otherwise work with RDoc.  This
-document provides an overview of how RDoc works from parsing options to
-generating output.  Most of the documentation can be found in the specific
-classes for each feature.
-
-== Bugs
-
-If you think you found a bug, file a ticket on the {issues
-tracker}[https://github.com/ruby/rdoc/issues] on github.
-
-If your bug involves an error RDoc produced please include a sample file that
-illustrates the problem or link to the repository or gem that is associated
-with the bug.
-
-Please include steps to reproduce the issue.  Here are some examples of good
-issues:
-
-* https://github.com/ruby/rdoc/issues/55
-* https://github.com/ruby/rdoc/issues/61
-
-== Developer Quick Start
-
-RDoc uses bundler for development.  To get ready to work on RDoc run:
-
-  $ gem install bundler
-  [...]
-  $ bundle install
-  [...]
-  $ rake
-  [...]
-
-This will install all the necessary dependencies for development with rake,
-generate documentation and run the tests for the first time.
-
-If the tests don't pass on the first run check the {Travis CI page for
-RDoc}[https://travis-ci.org/ruby/rdoc] to see if there are any known failures
-(there shouldn't be).
-
-You can now use `rake` and `autotest` to run the tests.
-
-Note: the `rake` command must be used first before running any tests, because
-its used to generate various parsers implemented in RDoc. Also `rake clean` is
-helpful to delete these generated files.
-
-== Glossary
-
-Here are definitions for some common terms in the RDoc documentation.  The
-list also briefly describes how the components of RDoc interact.
-
-parser::
-  Parses files and creates a documentation tree from the contents.
-
-documentation tree::
-  The documentation tree represents files, classes, modules, methods,
-  constants, includes, comments and other ruby syntax features as a tree.
-  RDoc walks this tree with a generator to create documentation.
-
-generator::
-  Walks the documentation tree and generates output.
-
-  RDoc ships with two generators, the Darkfish generator creates HTML and the
-  RI generator creates an RI data store.
-
-markup parser::
-  Parses comments from a file into a generic markup tree.
-
-  The markup parsers allow RDoc to handle RDoc, TomDoc, rd and Markdown format
-  documentation with common formatters.
-
-markup tree::
-  Each parsed comment has a markup tree that represents common markup items
-  such as headings, paragraphs, lists or verbatim text sections for example
-  code or output.
-
-  A generator uses a formatters to walks the tree to create output.  Some
-  generators use multiple formatters on a markup tree to produce the output.
-
-formatter::
-  Converts a parsed markup tree into some form other form of markup.
-
-  Formatters can either produce a one-to-one conversion, such as ToHtml, or
-  extract part of the parsed result, such as ToHtmlSnippet which outputs the
-  first 100 characters as HTML.
-
-== Plugins
-
-When 'rdoc/rdoc' is loaded RDoc looks for 'rdoc/discover' files in your
-installed gems.  This can be used to load parsers, alternate generators, or
-additional preprocessor directives.  An rdoc plugin layout should look
-something like this:
-
-  lib/rdoc/discover.rb
-  lib/my/rdoc/plugin.rb
-  # etc.
-
-In your rdoc/discover.rb file you will want to wrap the loading of your plugin
-in an RDoc version check like this:
-
-  begin
-    gem 'rdoc', '~> 3'
-    require 'my/rdoc/plugin'
-  rescue Gem::LoadError
-  end
-
-=== Plugin Types
-
-In RDoc you can change the following behaviors:
-
-* Add a parser for a new file format
-* Add a new output generator
-* Add a new markup directive
-* Add a new type of documentation markup
-* Add a new type of formatter
-
-All of these are described below
-
-== Option Parsing
-
-Option parsing is handled by RDoc::Options.  When you're writing a generator
-you can provide the user with extra options by providing a class method
-+setup_options+.  The option parser will call this after your generator is
-loaded.  See RDoc::Generator for details.
-
-== File Parsing
-
-After options are parsed, RDoc parses files from the files and directories in
-ARGV.  RDoc compares the filename against what each parser claims it can parse
-via RDoc::Parser#parse_files_matching.  For example, RDoc::Parser::C can parse
-C files, C headers, C++ files, C++ headers and yacc grammars.
-
-Once a matching parser class is found it is instantiated and +scan+ is called.
-The parser needs to extract documentation from the file and add it to the RDoc
-document tree.  Usually this involves starting at the root and adding a class
-or a module (RDoc::TopLevel#add_class and RDoc::TopLevel#add_module) and
-proceeding to add classes, modules and methods to each nested item.
-
-When the parsers are finished the document tree is cleaned up to remove
-dangling references to aliases and includes that were not found (and may exist
-in a separate library) through RDoc::ClassModule#complete.
-
-To write your own parser for a new file format see RDoc::Parser.
-
-=== Documentation Tree
-
-The parsers build a documentation tree that is composed of RDoc::CodeObject and
-its subclasses.  There are various methods to walk the tree to extract
-information, see RDoc::Context and its subclasses.
-
-Within a class or module, attributes, methods and constants are divided into
-sections.  The section represents a functional grouping of parts of the class.
-TomDoc uses the sections "Public", "Internal" and "Deprecated".  The sections
-can be enumerated using RDoc::Context#each_section.
-
-== Output Generation
-
-An RDoc generator turns the documentation tree into some other kind of output.
-RDoc comes with an HTML generator (RDoc::Generator::Darkfish) and an RI
-database generator (RDoc::Generator::RI).  The output a generator creates does
-not have to be human-readable.
-
-To create your own generator see RDoc::Generator.
-
-=== Comments
-
-In RDoc 3.10 and newer the comment on an RDoc::CodeObject is now an
-RDoc::Comment object instead of a String.  This is to support various
-documentation markup formats like rdoc, TomDoc and rd.  The comments are
-normalized to remove comment markers and remove indentation then parsed lazily
-via RDoc::Comment#document to create a generic markup tree that can be
-processed by a formatter.
-
-To add your own markup format see RDoc::Markup@Other+directives
-
-==== Formatters
-
-To transform a comment into some form of output an RDoc::Markup::Formatter
-subclass is used like RDoc::Markup::ToHtml.  A formatter is a visitor that
-walks a parsed comment tree (an RDoc::Markup::Document) of any format.  To help
-write a formatter RDoc::Markup::FormatterTestCase exists for generic parsers,
-and RDoc::Markup::TextFormatterTestCase which contains extra test cases for
-text-type output (like +ri+ output).
-
-RDoc ships with formatters that will turn a comment into HTML, rdoc-markup-like
-text, ANSI or terminal backspace highlighted text, HTML, cross-referenced HTML,
-an HTML snippet free of most markup, an HTML label for use in id attributes, a
-table-of-contents page, and text with only code blocks.
-
-The output of the formatter does not need to be text or text-like.
-RDoc::Markup::ToLabel creates an HTML-safe label for use in an HTML id
-attribute.  A formatter could count the number of words and the average word
-length for a comment, for example.
-
-==== Directives
-
-For comments in markup you can add new directives (:nodoc: is a directive).
-Directives may replace text or store it off for later use.
-
-See RDoc::Markup::PreProcess::register for details.
-
-=== JSONIndex
-
-RDoc contains a special generator, RDoc::Generator::JSONIndex, which creates a
-JSON-based search index and includes a search engine for use with HTML output.
-This generator can be used to add searching to any HTML output and is designed
-to be called from inside an HTML generator.
-
-== Markup
-
-Additional documentation markup formats can be added to RDoc.  A markup
-parsing class must respond to \::parse and accept a String argument containing
-the markup format.  An RDoc::Document containing documentation items
-(RDoc::Markup::Heading, RDoc::Markup::Paragraph, RDoc::Markup::Verbatim, etc.)
-must be returned.
-
-To register the parser with rdoc, add the markup type's name and class to the
-RDoc::Text::MARKUP_FORMAT hash like:
-
-  RDoc::Text::MARKUP_FORMAT['rdoc'] = RDoc::Markup

data/ExampleMarkdown.md

@@ -1,37 +0,0 @@
-This document contains example output to show RDoc styling.  This file was
-created from a Markdown file.
-
-For the following styles, see ExampleRDoc.rdoc for style examples:
-
-* Headings
-* Paragraphs
-* Code blocks (verbatim sections)
-* Definition lists
-* Ordered lists
-* Unordered lists
-
-These items all use the same styles as RDoc format files.
-
-## Footnotes
-
-Footnotes are rendered at the bottom of the documentation section[^1].  For
-pages this will be at the bottom of the page.  For method documentation this
-will be at the end of the current method.
-
-[^1]: Here is the footnote content.  As you can see it is at the bottom of the
-page.
-
-## Blockquotes
-
-Here is how a blockquote looks.
-
-> We finished our first sensor sweep of the neutral zone. Now, how the hell do
-> we defeat an enemy that knows us better than we know ourselves? and attack
-> the Romulans.
->
-> > Sorry, Data. I guess it's better to be lucky than good. The unexpected is
-> > our normal routine. Could someone survive inside a transporter buffer for
-> > 75 years?
-
-This text is from [Riker Ipsum](http://rikeripsum.com)
-