Avoid generating documentation pages for internal components #1047
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
st0012
commented
Dec 12, 2024
| RDoc::Task.new do |rdoc| | ||
| rdoc.title = "IRB" | ||
| rdoc.rdoc_files.include("*.md", "lib/**/*.rb") | ||
| rdoc.rdoc_files.exclude("lib/irb/xmp.rb") |
Member
Author
There was a problem hiding this comment.
If we use these options, .document will be ignored. Since .document will be applied to ruby/ruby's documentation generation too, we should prioritize using it.
Member
Author
There was a problem hiding this comment.
Actually, this is not correct. I think it'd be better if that's the case though. Will see how I can make it happen.
Member
Author
There was a problem hiding this comment.
@tompng I opened ruby/ruby#12325 for this. Can you review it there too?
tompng
reviewed
Dec 13, 2024
st0012
force-pushed
the
cleanup-documentation-files
branch
from
5bb2088 to
da518ee
Compare
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Dec 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the documentation website lists most of IRB's internal classes/modules...etc.
They're not helpful to end users and are mostly undocumented anyway. Therefore, we should avoid generating documentation for them.
Result:
