[DOC] Exclude irb from documentation generation #12325
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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.
st0012
changed the title
|
It depends on the policy of ruby/ruby's document, but I think this change makes sense. I think having only a single document URL is less confusing. Some default gem's document will be removed from docs.ruby-lang.org when it become a bundled gem, so the standalone document deployed in each gem will last longer. |
jeremyevans
approved these changes
Dec 16, 2024
st0012
added a commit
to Shopify/ruby
that referenced
this pull request
Dec 20, 2024
Follow-up to ruby#12325 Since we're not generating IRB documentation, we don't need to sync its `doc/` folder and keep the previous content.
tompng
pushed a commit
that referenced
this pull request
Jan 2, 2025
Follow-up to #12325 Since we're not generating IRB documentation, we don't need to sync its `doc/` folder and keep the previous content.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Implementation
The
.rdoc_optionschange will exclude IRB fromdocs.ruby-lang.org/en's documentation generation. And since IRB is not included anymore, thelib/irb/.documentis obsolete so I deleted it (which was manually added in the past, not synced fromruby/irb).I also checked the there are no references to IRB so it should not break any links.