Data

Tools

Indexes

Applications

Experiments

Ruby

A summary of data about the Ruby ecosystem.

https://github.com/ruby/rdoc

RDoc produces HTML and online documentation for Ruby projects.
https://github.com/ruby/rdoc

Keywords

documentation-tool hacktoberfest ruby

Keywords from Contributors

rubygems activerecord mvc activejob rack json-parser repl ruby-gem rspec yaml-parser

Last synced: about 22 hours ago
JSON representation

Repository metadata

RDoc produces HTML and online documentation for Ruby projects.

README.md

RDoc - Ruby Documentation System

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.

Generating Documentation

Once installed, you can create documentation using the rdoc command

rdoc [options] [names...]

For an up-to-date option summary, type

rdoc --help

A typical use might be to generate documentation for a package of Ruby source (such as RDoc itself).

rdoc

This command generates documentation for all the Ruby and C source files in and below the current directory. These will be stored in a documentation tree starting in the subdirectory doc.

You can make this slightly more useful for your readers by having the index page contain the documentation for the primary file. In our case, we could type

rdoc --main README.md

You'll find information on the various formatting tricks you can use in comment blocks in the documentation this generates.

RDoc uses file extensions to determine how to process each file. File names ending .rb and .rbw are assumed to be Ruby source. Files ending .c are parsed as C files. All other files are assumed to contain just Markup-style markup (with or without leading # comment markers). If directory names are passed to RDoc, they are scanned recursively for C and Ruby source files only.

To generate documentation using rake see RDoc::Task.

To generate documentation programmatically:

require 'rdoc/rdoc'

options = RDoc::Options.new
options.files = ['a.rb', 'b.rb']
options.setup_generator 'darkfish'
# see RDoc::Options

rdoc = RDoc::RDoc.new
rdoc.document options
# see RDoc::RDoc

You can specify the target files for document generation with .document file in the project root directory. .document file contains a list of file and directory names including comment lines starting with #. See https://github.com/ruby/rdoc/blob/master/.document as an example.

Writing Documentation

To write documentation for RDoc place a comment above the class, module, method, constant, or attribute you want documented:

##
# This class represents an arbitrary shape by a series of points.
class Shape
  ##
  # Creates a new shape described by a +polyline+.
  #
  # If the +polyline+ does not end at the same point it started at the
  # first pointed is copied and placed at the end of the line.
  #
  # An ArgumentError is raised if the line crosses itself, but shapes may
  # be concave.
  def initialize polyline
    # ...
  end
end

The default comment markup format is the RDoc::Markup format. TomDoc, Markdown and RD format comments are also supported. You can set the default comment format for your entire project by creating a .rdoc_options file. See RDoc::Options@Saved+Options for instructions on creating one. You can also set the comment format for a single file through the :markup: directive, but this is only recommended if you wish to switch markup formats. See RDoc::Markup@Other+directives.

Comments can contain directives that tell RDoc information that it cannot otherwise discover through parsing. See RDoc::Markup@Directives to control what is or is not documented, to define method arguments or to break up methods in a class by topic. See RDoc::Parser::Ruby for directives used to teach RDoc about metaprogrammed methods.

See RDoc::Parser::C for documenting C extensions with RDoc.

To determine how well your project is documented run rdoc -C lib to get a documentation coverage report. rdoc -C1 lib includes parameter names in the documentation coverage report.

Theme Options

There are a few community-maintained themes for RDoc:

Please follow the theme's README for usage instructions.

Bugs

See CONTRIBUTING.rdoc for information on filing a bug report. It's OK to file a bug report for anything you're having a problem with. If you can't figure out how to make RDoc produce the output you like that is probably a documentation bug.

License

RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers. Portions (c) 2007-2011 Eric Hodel. Portions copyright others, see individual files and LEGAL.rdoc for details.

RDoc is free software, and may be redistributed under the terms specified in LICENSE.rdoc.

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 14 days ago

Total Commits: 3,421
Total Committers: 136
Avg Commits per committer: 25.154
Development Distribution Score (DDS): 0.513

Commits in past year: 225
Committers in past year: 26
Avg Commits per committer in past year: 8.654
Development Distribution Score (DDS) in past year: 0.631

Name Email Commits
Eric Hodel d****n@s****t 1667
Code Ass a****a@g****m 474
SHIBATA Hiroshi h****t@r****g 255
Nobuyoshi Nakada n****u@r****g 243
Stan Lo s****2@g****m 108
dependabot[bot] 4****] 87
Designing Patterns t****s@d****m 62
Zachary Scott e@z****o 49
tomoya ishida t****n@g****m 32
Zachary Scott z****y@z****t 27
Burdette Lamar B****r@Y****m 26
Tom Copeland t****m@i****m 25
Yusuke Endoh m****e@r****g 18
Kouhei Sutou k****u@c****m 17
Kazuhiro NISHIYAMA zn@m****m 15
Phil Hagelberg p****l@h****g 13
Mike Dalessio m****o@g****m 12
Erik Hollensbe e****b@h****g 11
Jeremy Evans c****e@j****t 11
Benoit Daloze e****p@g****m 9
Masafumi Koba 4****s 9
Ryan Davis r****y@z****m 8
Vinicius Stock s****k@h****m 8
Yusuke Nakamura y****5@g****m 8
Marcus Stollsteimer s****r@w****e 7
Petrik p****k@d****t 7
Peter Zhu p****r@p****a 6
toshimaru me@t****t 6
zzak z****t@g****m 6
David Rodríguez d****z@r****t 5
and 106 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 109
Total pull requests: 670
Average time to close issues: 10 months
Average time to close pull requests: about 1 month
Total issue authors: 54
Total pull request authors: 62
Average comments per issue: 1.0
Average comments per pull request: 1.08
Merged pull request: 516
Bot issues: 0
Bot pull requests: 126

Past year issues: 43
Past year pull requests: 304
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 4 days
Past year issue authors: 21
Past year pull request authors: 28
Past year average comments per issue: 0.79
Past year average comments per pull request: 1.04
Past year merged pull request: 228
Past year bot issues: 0
Past year bot pull requests: 56

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ruby/rdoc

Top Issue Authors

  • BurdetteLamar (12)
  • st0012 (12)
  • okuramasafumi (7)
  • nobu (6)
  • hsbt (6)
  • gemmaro (3)
  • zenspider (3)
  • halostatue (3)
  • flavorjones (2)
  • Earlopain (2)
  • ioquatix (2)
  • headius (2)
  • p8 (2)
  • zzak (2)
  • tompng (2)

Top Pull Request Authors

  • st0012 (156)
  • dependabot[bot] (126)
  • nobu (69)
  • tompng (37)
  • BurdetteLamar (32)
  • hsbt (25)
  • okuramasafumi (19)
  • p8 (18)
  • flavorjones (15)
  • zzak (14)
  • ybiquitous (12)
  • sunblaze (11)
  • nevans (11)
  • vinistock (10)
  • skipkayhil (8)

Top Issue Labels

  • bug (12)
  • enhancement (6)
  • Feature Request (4)
  • markup-markdown (3)
  • Bug (2)
  • Non-Bug (1)
  • documentation (1)

Top Pull Request Labels

  • dependencies (126)
  • enhancement (71)
  • bug (53)
  • github_actions (33)
  • documentation (31)
  • Documentation (7)
  • Feature Request (6)
  • experimental (2)
  • refactor (2)
  • integration_testng (2)
  • Bug (1)
  • Performance (1)

Package metadata

gem.coop: rdoc

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.

rubygems.org: rdoc

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.

proxy.golang.org: github.com/ruby/rdoc

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/ruby/rdoc#section-documentation
  • Licenses: other
  • Latest release: v6.16.1+incompatible (published 11 days ago)
  • Last Synced: 2025-12-05T06:03:06.570Z (4 days ago)
  • Versions: 63
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Forks count: 1.352%
    • Stargazers count: 2.208%
    • Average: 5.984%
    • Dependent packages count: 9.576%
    • Dependent repos count: 10.802%

Dependencies

Gemfile rubygems
  • gettext >= 0 development
  • kpeg >= 0 development
  • racc > 1.4.10 development
  • rake >= 0 development
  • rubocop >= 0 development
  • test-unit >= 0 development
rdoc.gemspec rubygems
  • psych >= 4.0.0
.github/workflows/test.yml actions
  • actions/checkout ac593985615ec2ede58e132d2e21d2b1cbd6127c composite
  • ruby/setup-ruby 319066216501fbd5e2d568f14b7d68c19fb67a5d composite
.github/workflows/gh-pages.yml actions
  • actions/checkout v3 composite
  • actions/configure-pages v3 composite
  • actions/deploy-pages v2 composite
  • actions/upload-pages-artifact v1 composite
  • ruby/setup-ruby 250fcd6a742febb1123a77a841497ccaa8b9e939 composite

Score: 34.90842541183583