Reduce RDoc generation time by not including every README #1671
Conversation
This file contains 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
epergo
commented
Dec 28, 2020
| s.extra_rdoc_files = s.files.select { |p| p =~ /^README/ } << 'LICENSE' | ||
| s.rdoc_options = %w[--line-numbers --inline-source --title Sinatra --main README.rdoc --encoding=UTF-8] | ||
| s.extra_rdoc_files = %w[README.md LICENSE] | ||
| s.rdoc_options = %w[--line-numbers --title Sinatra --main README.rdoc --encoding=UTF-8] |
There was a problem hiding this comment.
I've removed --inline-source because is the default behaviour
epergo
commented
Dec 28, 2020
| @@ -33,11 +33,6 @@ Gem::Specification.new 'sinatra', version do |s| | |||
| 'documentation_uri' => 'https://www.rubydoc.info/gems/sinatra' | |||
| } | |||
| else | |||
| msg = "RubyGems 2.0 or newer is required to protect against public "\ | |||
There was a problem hiding this comment.
This variable wasn't used
epergo
changed the title
|
This looks like a good change to me, @namusyaka what do you think? |
namusyaka
approved these changes
Jan 7, 2021
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.
👋 I've recently stumbled across #1578 . Here I've done the changes requested in the issue, that is not including every README file, I've only included the english version in the RDoc documentation.
At my machine time needed to generate documentation decreases drastically:
I understand if we decide not to merge this as it would mean not including every language in the RDoc result, and it may come handy for some people, but having in mind that the rest of the documentation is in English and Readmes in other languages can be still read in this repository and in http://sinatrarb.com I think it shouldn't cause much negative impact.
WDYT?