Allow disabling documentation generation for some gems
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 873
- Forks
- 164
- Avg merge
- 4d 27m
- Merged PRs (30d)
- 9
Description
Some gems such as parser or rubocop are known to slowing down Tapioca RBI generation.
While we are thinking about an alternative way to generate the documentation for all gems, it would be nice if Tapioca offered a mechanism to disable documentation generation on a per-gem basis.
Maybe something like this in the configuration:
gem:
doc: true
doc-exclude:
- parser
- rubocop
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing Tapioca's configuration handling and the RBI generation path that produces gem documentation. Check how gem names and documentation settings are represented, then identify the existing configuration and generation tests. Done means a per-gem exclusion setting is supported and verified for gems such as parser and rubocop without disabling documentation globally.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100