Skip to content

Commit 4e303b3

Browse files
authored
Bump RDoc to 8.0.0 (ruby#1745)
Prepare RDoc 8.0.0 by bumping the version constant from 7.2.0 to 8.0.0. Darkfish stays available in 8.0; the deprecation docs now target removal in 9.0 instead. Changes since 7.2.0: https://github.com/ruby/rdoc/compare/v7.2.0..master
1 parent 0042785 commit 4e303b3

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ lib/rdoc/
185185
├── server.rb # Live-reloading preview server (rdoc --server)
186186
├── generator/ # Documentation generators
187187
│ ├── aliki.rb # HTML generator (default theme)
188-
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
188+
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v9.0)
189189
│ ├── markup.rb # Markup format generator
190190
│ ├── ri.rb # RI command generator
191191
│ └── template/ # ERB templates (.rhtml files)

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ bundle exec rake coverage
146146
RDoc ships with two HTML themes:
147147

148148
- **Aliki** (default) - Modern theme with improved styling and navigation
149-
- **Darkfish** (deprecated) - Classic theme, will be removed in v8.0
149+
- **Darkfish** (deprecated) - Classic theme, will be removed in v9.0
150150

151151
New feature development should focus on the Aliki theme. Darkfish will continue to receive bug fixes but no new features.
152152

@@ -165,7 +165,7 @@ lib/rdoc/
165165
│ └── ...
166166
├── generator/ # Documentation generators
167167
│ ├── aliki.rb # HTML generator (default theme)
168-
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
168+
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v9.0)
169169
│ ├── markup.rb # Markup format generator
170170
│ ├── ri.rb # RI command generator
171171
│ └── template/ # ERB templates

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ To determine how well your project is documented run `rdoc -C lib` to get a docu
165165
RDoc ships with two built-in themes:
166166

167167
- **Aliki** (default) - A modern, clean theme with improved navigation and search
168-
- **Darkfish** (deprecated) - The classic theme, will be removed in v8.0
168+
- **Darkfish** (deprecated) - The classic theme, will be removed in v9.0
169169

170170
To use the Darkfish theme instead of the default Aliki theme:
171171

doc/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Each group below renders as a table with these columns:
255255
| Option | `.rdoc_options` | `RDoc::Task` | Effective default | Notes |
256256
|---|---|---|---|---|
257257
| `--output DIR` / `-o` / `--op` | `op_dir` | `rdoc.rdoc_dir` | CLI: `'doc'`; `RDoc::Task`: `'html'` | Output directory. RDoc also writes a `created.rid` marker here. |
258-
| `--format FORMAT` / `-f` / `--fmt` | `generator_name` | `rdoc.generator` | `'aliki'` | Generator name. Installed generators: `aliki` (HTML, default), `darkfish` *(deprecated, removal in v8.0)*, `ri`, `pot`. |
258+
| `--format FORMAT` / `-f` / `--fmt` | `generator_name` | `rdoc.generator` | `'aliki'` | Generator name. Installed generators: `aliki` (HTML, default), `darkfish` *(deprecated, removal in v9.0)*, `ri`, `pot`. |
259259
| `--ri` / `-r` | *(sets `generator_name: ri`)* ||| Shortcut: generate `ri` output into `~/.rdoc`. |
260260
| `--ri-site` / `-R` | *(sets `generator_name: ri`)* ||| Shortcut: generate `ri` output into the site-wide directory. |
261261

lib/rdoc/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ module RDoc
55
##
66
# RDoc version you are using
77

8-
VERSION = '7.2.0'
8+
VERSION = '8.0.0'
99

1010
end

0 commit comments

Comments
 (0)