{"id":13483927,"url":"https://github.com/ruby/rdoc","last_synced_at":"2026-01-15T22:21:19.257Z","repository":{"id":1255322,"uuid":"1194027","full_name":"ruby/rdoc","owner":"ruby","description":"RDoc produces HTML and online documentation for Ruby projects.","archived":false,"fork":false,"pushed_at":"2025-05-06T16:59:36.000Z","size":8306,"stargazers_count":858,"open_issues_count":140,"forks_count":441,"subscribers_count":65,"default_branch":"master","last_synced_at":"2025-05-07T21:58:57.238Z","etag":null,"topics":["documentation-tool","hacktoberfest","ruby"],"latest_commit_sha":null,"homepage":"https://ruby.github.io/rdoc/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruby.png","metadata":{"files":{"readme":"README.rdoc","changelog":"History.rdoc","contributing":"CONTRIBUTING.rdoc","funding":null,"license":"LICENSE.rdoc","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2010-12-23T19:32:54.000Z","updated_at":"2025-05-06T16:59:41.000Z","dependencies_parsed_at":"2024-01-08T17:13:38.452Z","dependency_job_id":"bfba387e-62fb-42ea-8030-fc4fa18f60c7","html_url":"https://github.com/ruby/rdoc","commit_stats":{"total_commits":3190,"total_committers":142,"mean_commits":"22.464788732394368","dds":"0.47774294670846396","last_synced_commit":"68525676407102753e63de33b987fe069d3e6625"},"previous_names":[],"tags_count":104,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Frdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Frdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Frdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby%2Frdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruby","download_url":"https://codeload.github.com/ruby/rdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253062030,"owners_count":21847850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-tool","hacktoberfest","ruby"],"created_at":"2024-07-31T17:01:16.933Z","updated_at":"2026-01-15T22:21:19.211Z","avatar_url":"https://github.com/ruby.png","language":"Ruby","funding_links":[],"categories":["Ruby","Happy Exploring 🤘","Documentation"],"sub_categories":[],"readme":"= \\RDoc - Ruby Documentation System\n\nhome :: https://github.com/ruby/rdoc\nrdoc :: https://ruby.github.io/rdoc\nbugs :: https://github.com/ruby/rdoc/issues\ncode quality :: https://codeclimate.com/github/ruby/rdoc\n\n== Description\n\nRDoc produces HTML and command-line documentation for Ruby projects.  RDoc\nincludes the +rdoc+ and +ri+ tools for generating and displaying documentation\nfrom the command-line.\n\n== Generating Documentation\n\nOnce installed, you can create documentation using the +rdoc+ command\n\n  $ rdoc [options] [names...]\n\nFor an up-to-date option summary, type\n\n  $ rdoc --help\n\nA typical use might be to generate documentation for a package of Ruby\nsource (such as RDoc itself).\n\n  $ rdoc\n\nThis command generates documentation for all the Ruby and C source\nfiles in and below the current directory.  These will be stored in a\ndocumentation tree starting in the subdirectory +doc+.\n\nYou can make this slightly more useful for your readers by having the\nindex page contain the documentation for the primary file.  In our\ncase, we could type\n\n  % rdoc --main README.rdoc\n\nYou'll find information on the various formatting tricks you can use\nin comment blocks in the documentation this generates.\n\nRDoc uses file extensions to determine how to process each file.  File names\nending +.rb+ and +.rbw+ are assumed to be Ruby source.  Files\nending +.c+ are parsed as C files.  All other files are assumed to\ncontain just Markup-style markup (with or without leading '#' comment\nmarkers).  If directory names are passed to RDoc, they are scanned\nrecursively for C and Ruby source files only.\n\nTo generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDoc/Task.html].\n\nTo generate documentation programmatically:\n\n  gem 'rdoc'\n  require 'rdoc/rdoc'\n\n  options = RDoc::Options.new\n  options.files = ['a.rb', 'b.rb']\n  options.setup_generator 'darkfish'\n  # see RDoc::Options\n\n  rdoc = RDoc::RDoc.new\n  rdoc.document options\n  # see RDoc::RDoc\n\nYou can specify the target files for document generation with +.document+ file in the project root directory.\n+.document+ file contains a list of file and directory names including comment lines starting with '#'.\nSee https://github.com/ruby/rdoc/blob/master/.document as an example.\n\n== Writing Documentation\n\nTo write documentation for RDoc place a comment above the class, module,\nmethod, constant, or attribute you want documented:\n\n  ##\n  # This class represents an arbitrary shape by a series of points.\n\n  class Shape\n\n    ##\n    # Creates a new shape described by a +polyline+.\n    #\n    # If the +polyline+ does not end at the same point it started at the\n    # first pointed is copied and placed at the end of the line.\n    #\n    # An ArgumentError is raised if the line crosses itself, but shapes may\n    # be concave.\n\n    def initialize polyline\n      # ...\n    end\n\n  end\n\nThe default comment markup format is the RDoc::Markup format.\nTomDoc[rdoc-ref:RDoc::TomDoc], Markdown[rdoc-ref:RDoc::Markdown] and\nRD[rdoc-ref:RDoc::RD] format comments are also supported.  You can set the\ndefault comment format for your entire project by creating a\n\u003ctt\u003e.rdoc_options\u003c/tt\u003e file.  See RDoc::Options@Saved+Options for instructions\non creating one.  You can also set the comment format for a single file\nthrough the +:markup:+ directive, but this is only recommended if you wish to\nswitch markup formats.  See RDoc::Markup@Other+directives.\n\nComments can contain directives that tell RDoc information that it cannot\notherwise discover through parsing.  See RDoc::Markup@Directives to control\nwhat is or is not documented, to define method arguments or to break up\nmethods in a class by topic.  See RDoc::Parser::Ruby for directives used to\nteach RDoc about metaprogrammed methods.\n\nSee RDoc::Parser::C for documenting C extensions with RDoc.\n\nTo determine how well your project is documented run \u003ctt\u003erdoc -C lib\u003c/tt\u003e to\nget a documentation coverage report.  \u003ctt\u003erdoc -C1 lib\u003c/tt\u003e includes parameter\nnames in the documentation coverage report.\n\n== Theme Options\n\nThere are a few community-maintained themes for \\RDoc:\n\n- rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc]\n- hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans])\n\nPlease follow the theme's README for usage instructions.\n\n== Bugs\n\nSee CONTRIBUTING.rdoc for information on filing a bug report.  It's OK to file\na bug report for anything you're having a problem with.  If you can't figure\nout how to make RDoc produce the output you like that is probably a\ndocumentation bug.\n\n== License\n\nRDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.\nPortions (c) 2007-2011 Eric Hodel.  Portions copyright others, see individual\nfiles and LEGAL.rdoc for details.\n\nRDoc is free software, and may be redistributed under the terms specified in\nLICENSE.rdoc.\n\n== Warranty\n\nThis software is provided \"as is\" and without any express or implied\nwarranties, including, without limitation, the implied warranties of\nmerchantability and fitness for a particular purpose.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby%2Frdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruby%2Frdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby%2Frdoc/lists"}