Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align behaviour between bundle exec rdoc and rake rdoc #1156

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Align behaviour between bundle exec rdoc and rake rdoc #1156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e60ea35
Align behaviour between `bundle exec rdoc` and `rake rdoc`
st0012 Aug 19, 2024
c5bff87
Apply suggestions from code review
st0012 Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .document
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
History.txt
LICENSE.txt
README.txt
RI.txt
RI.md
*.md
*.rdoc
lib
doc
8 changes: 8 additions & 0 deletions .rdoc_options
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
exclude:
- lib/rdoc/rd/block_parser.ry
- lib/rdoc/rd/inline_parser.ry
- lib/rdoc/markdown.kpeg
- lib/rdoc/markdown/literals.kpeg
op_dir: _site # for GitHub Pages and should match the config of RDoc task in Rakefile
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--op-dir option is not saved by --write-options.
Is this expected?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is. But the bigger problem is that the presence of options (and some of their names) are different across Rake task, command line, and .rdoc_options. I think we should do a review and consolidation on them next year.

title: rdoc Documentation
main_page: README.rdoc
6 changes: 2 additions & 4 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ task :default => :test

task rdoc: :generate
RDoc::Task.new do |doc|
doc.main = 'README.rdoc'
doc.title = "rdoc #{RDoc::VERSION} Documentation"
doc.rdoc_dir = '_site' # for github pages
doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc *.md doc/rdoc/markup_reference.rb] - PARSER_FILES
# RDoc task defaults to /html and overrides the op_dir option in .rdoc_options
doc.rdoc_dir = "_site" # for GitHub Pages
end

task "coverage" do
Expand Down