ruby / ruby/rdoc

Select which files to only generate in .gemspec

Open
#501 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

Is there's already a way to make generation of rdoc (html) and ri files when the gem gets installed minimized to only a few specific files? If not, can this feature be added?

Specifying specific files through spec.rdoc_options doesn't help (did it after examining rubygems_hook.rb). And using --exclude, if it may work, would be ugly since it would have to match every file that could be included.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading rubygems_hook.rb and the .gemspec handling around spec.rdoc_options; the issue reports that selecting specific files there does not work. Determine the intended way to limit generated RDoc HTML and RI files, then define and verify a complete selection mechanism whose behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.