Include files relative to the framework root #360
Closed
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
❌ Deploy Preview for sdoc failed.
|
The Rails documentation uses the `:include:` directive to inline the
README of the framework into the main documentation page.
As the README's aren't in the root directory from where SDoc is run we
need to add the framework path to the include:
# :include: activesupport/README.md
This results in a warning when installing the gems as generating the
rdoc for the gem is run from the gem/framework root:
Couldn't find file to include 'activesupport/README.rdoc' from lib/active_support.rb
By Monkeypatching `find_include_file` to find files at the framework
root we can include without the framework path:
# :include: README.md
p8
force-pushed
the
improve-readme-includes
branch
from
8d18c1e to
49f2014
Compare
p8
commented
Jan 17, 2024
|
|
||
| RDoc::Markup::PreProcess.prepend(Module.new do | ||
| def find_include_file(name) | ||
| to_search = [File.dirname(File.dirname(@input_file_name))].concat @include_path |
There was a problem hiding this comment.
The following would be nicer but won't work on Ruby 2.7:
Suggested change
| to_search = [File.dirname(File.dirname(@input_file_name))].concat @include_path | |
| to_search = [File.dirname(@input_file_name, 2)].concat @include_path |
|
Closing in favor of the much cleaner rails/rails#50789 |
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.
The Rails documentation uses the
:include:directive to inline the README of the framework into the main documentation page. As the README's aren't in the root directory from where SDoc is run we need to add the framework path to the include:This results in a warning when installing the gems as generating the rdoc for the gem is run from the gem/framework root:
By Monkeypatching
find_include_fileto find files at the framework root we can include without the framework path:Fixes: rails/rails#49524