Skip to content

Commit

Permalink
Exclude irb from documentation generation
Browse files Browse the repository at this point in the history
- IRB has its own documentation in the project readme and https://ruby.github.io/irb/ already.
- As a tool, its internal implementation details are not relevant to the user.
- Excluding it from the documentation generation reduces the size of the generated documentation
  and makes search results more relevant.

I also checked the there are no references to IRB so it should not break any links.
  • Loading branch information
st0012 authored and jeremyevans committed Dec 16, 2024
1 parent 29d3ea1 commit cf71186
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .rdoc_options
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ title: Documentation for Ruby development version
visibility: :private
rdoc_include:
- doc

exclude:
- lib/irb
1 change: 0 additions & 1 deletion lib/irb/.document

This file was deleted.

0 comments on commit cf71186

Please sign in to comment.