omit Class and Module Index
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
If I run:
rdoc --main hello.rb
I can then visit index.html, which includes the documentation from
hello.rb and also a search box and "Class and Module Index".
However sometimes I would only like the documentation for hello.rb, and no
side panel. Is this possible?
Contributor guide
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 how rdoc --main hello.rb generates index.html, including the search box and Class and Module Index. Determine whether an existing option or configuration controls the side panel; done means documenting or adding a way to generate only the hello.rb documentation without that panel.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100