Skip to content

Commit eccac8d

Browse files
committed
Update documentation to reflect Darkfish removal
- README: Remove Darkfish theme instructions, simplify theme section - CONTRIBUTING: Remove Darkfish from themes and project structure - AGENTS: Remove Darkfish from structure tree and generators list - LEGAL: Remove Darkfish, JsonIndex/SDoc, and Fonts sections - .stylelintrc.json: Remove darkfish CSS from ignoreFiles
1 parent 419318a commit eccac8d

File tree

5 files changed

+9
-65
lines changed

5 files changed

+9
-65
lines changed

.stylelintrc.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
{
22
"extends": "stylelint-config-standard",
33
"plugins": ["stylelint-value-no-unknown-custom-properties"],
4-
"ignoreFiles": [
5-
"lib/rdoc/generator/template/darkfish/css/**/*.css"
6-
],
74
"rules": {
85
"csstools/value-no-unknown-custom-properties": true,
96
"custom-property-no-missing-var-function": true,

AGENTS.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,12 +178,10 @@ lib/rdoc/
178178
│ └── ...
179179
├── generator/ # Documentation generators
180180
│ ├── aliki.rb # HTML generator (default theme)
181-
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
182181
│ ├── markup.rb # Markup format generator
183182
│ ├── ri.rb # RI command generator
184183
│ └── template/ # ERB templates (.rhtml files)
185-
│ ├── aliki/ # Aliki theme (default)
186-
│ └── darkfish/ # Darkfish theme (deprecated)
184+
│ └── aliki/ # Aliki theme
187185
├── markup/ # Markup parsing and formatting
188186
├── code_object/ # AST objects for documented items
189187
├── markdown/ # Markdown parsing
@@ -230,7 +228,7 @@ exe/
230228
### Pluggable System
231229

232230
- **Parsers:** Ruby, C, Markdown, RD, Prism-based Ruby (experimental)
233-
- **Generators:** HTML/Aliki (default), HTML/Darkfish (deprecated), RI, POT (gettext), JSON, Markup
231+
- **Generators:** HTML/Aliki (default), RI, POT (gettext), Markup
234232

235233
## Common Workflows
236234

@@ -317,7 +315,7 @@ When editing markup reference documentation, such as `doc/markup_reference/markd
317315

318316
### Modifying Themes/Styling
319317

320-
When making changes to theme CSS or templates (e.g., Darkfish or Aliki themes):
318+
When making changes to theme CSS or templates:
321319

322320
1. **Generate documentation**: Run `bundle exec rake rerdoc` to create baseline
323321
2. **Start HTTP server**: Run `cd _site && python3 -m http.server 8000` (use different port if 8000 is in use)

CONTRIBUTING.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -143,14 +143,9 @@ bundle exec rake coverage
143143

144144
## Themes
145145

146-
RDoc ships with two HTML themes:
146+
RDoc ships with the **Aliki** HTML theme, a modern theme with improved styling and navigation.
147147

148-
- **Aliki** (default) - Modern theme with improved styling and navigation
149-
- **Darkfish** (deprecated) - Classic theme, will be removed in v8.0
150-
151-
New feature development should focus on the Aliki theme. Darkfish will continue to receive bug fixes but no new features.
152-
153-
Theme templates are located at `lib/rdoc/generator/template/<theme>/`.
148+
Theme templates are located at `lib/rdoc/generator/template/aliki/`.
154149

155150
## Project Structure
156151

@@ -166,12 +161,10 @@ lib/rdoc/
166161
│ └── ...
167162
├── generator/ # Documentation generators
168163
│ ├── aliki.rb # HTML generator (default theme)
169-
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
170164
│ ├── markup.rb # Markup format generator
171165
│ ├── ri.rb # RI command generator
172166
│ └── template/ # ERB templates
173-
│ ├── aliki/ # Aliki theme (default)
174-
│ └── darkfish/ # Darkfish theme (deprecated)
167+
│ └── aliki/ # Aliki theme
175168
├── markup/ # Markup parsing and formatting
176169
├── code_object/ # AST objects for documented items
177170
├── markdown.kpeg # Parser source (edit this)

LEGAL.rdoc

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,9 @@ Aliki::
1010
* lib/rdoc/generator/aliki.rb
1111
* lib/rdoc/generator/template/aliki/*
1212

13-
Darkfish::
14-
Darkfish was written by Michael Granger and is included under the BSD 3-Clause
15-
license. Darkfish contains images from the Silk Icons set by Mark James.
16-
17-
See lib/rdoc/generator/darkfish.rb for license information.
18-
19-
* lib/rdoc/generator/darkfish.rb
20-
* lib/rdoc/generator/template/darkfish/*
21-
* lib/rdoc/generator/template/darkfish/images
22-
2313
SDoc::
24-
Portions of SDoc by (Володя Колесников) Vladimir Kolesnikov are included
25-
under the MIT license as RDoc::Generator::JsonIndex. See
26-
lib/rdoc/generator/json_index.rb for license information.
27-
28-
* lib/rdoc/generator/json_index.rb
29-
* lib/rdoc/generator/template/json_index/*
30-
* The +#search_index+ methods on RDoc::CodeObject subclasses were derived
31-
from sdoc.
32-
* RDoc::ClassModule#document_self_or_methods comes from SDoc.
14+
RDoc::ClassModule#document_self_or_methods comes from SDoc by
15+
(Володя Колесников) Vladimir Kolesnikov, included under the MIT license.
3316

3417
peg-markdown::
3518
RDoc's Markdown support is derived from peg-markdown by John MacFarlane. It
@@ -42,15 +25,3 @@ MarkdownTest::
4225
same terms as Perl itself.
4326

4427
See http://dev.perl.org/licenses/ for the terms of the Perl license.
45-
46-
Fonts::
47-
Source Code Pro is (c) 2010, 2012 Adobe Systems Incorporated.
48-
49-
Lato is (c) 2010 Łukasz Dziedzic.
50-
51-
Both fonts are used under the SIL Open Font License, Version 1.1. The
52-
license is available at http://scripts.sil.org/OFL
53-
54-
See lib/rdoc/generator/template/darkfish/fonts.css for complete copyright
55-
and license information, including a copy of the OFL.
56-

README.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -156,22 +156,7 @@ To determine how well your project is documented run `rdoc -C lib` to get a docu
156156

157157
## Theme Options
158158

159-
RDoc ships with two built-in themes:
160-
161-
- **Aliki** (default) - A modern, clean theme with improved navigation and search
162-
- **Darkfish** (deprecated) - The classic theme, will be removed in v8.0
163-
164-
To use the Darkfish theme instead of the default Aliki theme:
165-
166-
```shell
167-
rdoc --format darkfish
168-
```
169-
170-
Or in your `.rdoc_options` file:
171-
172-
```yaml
173-
generator_name: darkfish
174-
```
159+
RDoc ships with the **Aliki** theme, a modern, clean theme with improved navigation and search.
175160

176161
There are also a few community-maintained themes for RDoc:
177162

0 commit comments

Comments
 (0)