Add user-facing configuration reference#1692
Open
st0012 wants to merge 1 commit intoruby:masterfrom
Open
Conversation
A user-facing configuration reference for RDoc covering the four configuration mechanisms (`.rdoc_options`, `RDoc::Task`, `.document`, `RDOCOPT`), a name cheat sheet flagging the nine cross-mechanism naming mismatches, and a grouped options reference with defaults sourced from `RDoc::Options#init_ivars`.
st0012
requested a deployment
to
fork-preview-protection
GitHub Actions
Waiting
There was a problem hiding this comment.
Pull request overview
Adds a new user-facing documentation page (doc/configuration.md) that consolidates RDoc configuration mechanisms and option mappings into a single reference, intended to ship as part of RDoc’s own generated documentation.
Changes:
- Documented the four configuration mechanisms (
.rdoc_options,RDoc::Task,.document,RDOCOPT) including precedence and usage guidance. - Added a “name cheat sheet” and a cross-mechanism naming table mapping CLI flags ↔ YAML keys ↔
RDoc::Taskattributes. - Added grouped option reference tables plus worked examples for common setups.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| This writes a `.rdoc_options` file containing the current settings. | ||
|
|
||
| **Limitation.** Some options cannot be stored in `.rdoc_options` (they are silently ignored even if you add them). These are flagged in the [options reference](#options-reference) below. Examples: `--dry-run`, `--force-output`, `--force-update`, `--server`, `--pipe`, `--no-skipping-tests`, `--template`, `--template-stylesheets`. |
| | `--no-skipping-tests` | **CLI only** | — | skip tests | Without this flag, RDoc skips common test directory names (`test`, `spec`). | | ||
| | `--page-dir DIR` | `page_dir` | — | `nil` | Directory holding guides, FAQ, and other non-class pages. Do not reuse filenames from the project root. | | ||
| | `--root DIR` | **CLI only** | — | current dir | Root of the source tree. Set when building docs outside the source directory. | | ||
| | `--visibility VIS` | `visibility: :public` etc. | — | `:protected` | Minimum visibility: `:public`, `:protected`, `:private`, or `:nodoc` (show everything). YAML values must be symbols. | |
This file contains hidden or 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
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.
Summary
Adds
doc/configuration.md, a single-page reference covering how to configure RDoc..rdoc_options,RDoc::Task,.document, and theRDOCOPTenv var — with when to use each, syntax, and a worked example.--mainvsmain_pagevsrdoc.main;--output/op_dir/rdoc.rdoc_dir;--templatehaving no portable YAML form)..rdoc_optionskey,RDoc::Taskattribute, effective default, and notes.Rakefileequivalent,footer_contentfor the Aliki theme, and combining.document+exclude+--no-skipping-testsfor scope tuning.Defaults sourced from
RDoc::Options#init_ivarsandRDoc::Options#finish(which post-processes a few likeop_dir→'doc'andrdoc_include→[project root]);RDoc::Taskdefaults fromRDoc::Task#defaults(which differs in places, e.g.rdoc_dir = 'html').