Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .stylelintrc.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{
"extends": "stylelint-config-standard",
"plugins": ["stylelint-value-no-unknown-custom-properties"],
"ignoreFiles": [
"lib/rdoc/generator/template/darkfish/css/**/*.css"
],
"rules": {
"csstools/value-no-unknown-custom-properties": true,
"custom-property-no-missing-var-function": true,
Expand Down
8 changes: 3 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,10 @@ lib/rdoc/
│ └── ...
├── generator/ # Documentation generators
│ ├── aliki.rb # HTML generator (default theme)
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
│ ├── markup.rb # Markup format generator
│ ├── ri.rb # RI command generator
│ └── template/ # ERB templates (.rhtml files)
│ ├── aliki/ # Aliki theme (default)
│ └── darkfish/ # Darkfish theme (deprecated)
│ └── aliki/ # Aliki theme
├── markup/ # Markup parsing and formatting
├── code_object/ # AST objects for documented items
├── markdown/ # Markdown parsing
Expand Down Expand Up @@ -230,7 +228,7 @@ exe/
### Pluggable System

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

## Common Workflows

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

### Modifying Themes/Styling

When making changes to theme CSS or templates (e.g., Darkfish or Aliki themes):
When making changes to theme CSS or templates:

1. **Generate documentation**: Run `bundle exec rake rerdoc` to create baseline
2. **Start HTTP server**: Run `cd _site && python3 -m http.server 8000` (use different port if 8000 is in use)
Expand Down
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,9 @@ bundle exec rake coverage

## Themes

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

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

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

Theme templates are located at `lib/rdoc/generator/template/<theme>/`.
Theme templates are located at `lib/rdoc/generator/template/aliki/`.

## Project Structure

Expand All @@ -166,12 +161,10 @@ lib/rdoc/
│ └── ...
├── generator/ # Documentation generators
│ ├── aliki.rb # HTML generator (default theme)
│ ├── darkfish.rb # HTML generator (deprecated, will be removed in v8.0)
│ ├── markup.rb # Markup format generator
│ ├── ri.rb # RI command generator
│ └── template/ # ERB templates
│ ├── aliki/ # Aliki theme (default)
│ └── darkfish/ # Darkfish theme (deprecated)
│ └── aliki/ # Aliki theme
├── markup/ # Markup parsing and formatting
├── code_object/ # AST objects for documented items
├── markdown.kpeg # Parser source (edit this)
Expand Down
33 changes: 2 additions & 31 deletions LEGAL.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,9 @@ Aliki::
* lib/rdoc/generator/aliki.rb
* lib/rdoc/generator/template/aliki/*

Darkfish::
Darkfish was written by Michael Granger and is included under the BSD 3-Clause
license. Darkfish contains images from the Silk Icons set by Mark James.

See lib/rdoc/generator/darkfish.rb for license information.

* lib/rdoc/generator/darkfish.rb
* lib/rdoc/generator/template/darkfish/*
* lib/rdoc/generator/template/darkfish/images

SDoc::
Portions of SDoc by (Володя Колесников) Vladimir Kolesnikov are included
under the MIT license as RDoc::Generator::JsonIndex. See
lib/rdoc/generator/json_index.rb for license information.

* lib/rdoc/generator/json_index.rb
* lib/rdoc/generator/template/json_index/*
* The +#search_index+ methods on RDoc::CodeObject subclasses were derived
from sdoc.
* RDoc::ClassModule#document_self_or_methods comes from SDoc.
RDoc::ClassModule#document_self_or_methods comes from SDoc by
(Володя Колесников) Vladimir Kolesnikov, included under the MIT license.

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

See http://dev.perl.org/licenses/ for the terms of the Perl license.

Fonts::
Source Code Pro is (c) 2010, 2012 Adobe Systems Incorporated.

Lato is (c) 2010 Łukasz Dziedzic.

Both fonts are used under the SIL Open Font License, Version 1.1. The
license is available at http://scripts.sil.org/OFL

See lib/rdoc/generator/template/darkfish/fonts.css for complete copyright
and license information, including a copy of the OFL.

17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,22 +156,7 @@ To determine how well your project is documented run `rdoc -C lib` to get a docu

## Theme Options

RDoc ships with two built-in themes:

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

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

```shell
rdoc --format darkfish
```

Or in your `.rdoc_options` file:

```yaml
generator_name: darkfish
```
RDoc ships with the **Aliki** theme, a modern, clean theme with improved navigation and search.

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

Expand Down
18 changes: 0 additions & 18 deletions lib/rdoc/code_object/class_module.rb
Original file line number Diff line number Diff line change
Expand Up @@ -723,24 +723,6 @@ def remove_things(my_things, other_files) # :nodoc:
end
end

##
# Search record used by RDoc::Generator::JsonIndex
#
# TODO: Remove this method after dropping the darkfish theme and JsonIndex generator.
# Use #search_snippet instead for getting documentation snippets.

def search_record
[
name,
full_name,
full_name,
'',
path,
'',
snippet(@comment_location),
]
end

##
# Returns an HTML snippet of the first comment for search results.

Expand Down
19 changes: 0 additions & 19 deletions lib/rdoc/code_object/method_attr.rb
Original file line number Diff line number Diff line change
Expand Up @@ -372,25 +372,6 @@ def pretty_print(q) # :nodoc:
end
end

##
# Used by RDoc::Generator::JsonIndex to create a record for the search
# engine.
#
# TODO: Remove this method after dropping the darkfish theme and JsonIndex generator.
# Use #search_snippet instead for getting documentation snippets.

def search_record
[
@name,
full_name,
@name,
@parent.full_name,
path,
params,
search_snippet,
]
end

##
# Returns an HTML snippet of the comment for search results.

Expand Down
20 changes: 0 additions & 20 deletions lib/rdoc/code_object/top_level.rb
Original file line number Diff line number Diff line change
Expand Up @@ -237,26 +237,6 @@ def pretty_print(q) # :nodoc:
end
end

##
# Search record used by RDoc::Generator::JsonIndex
#
# TODO: Remove this method after dropping the darkfish theme and JsonIndex generator.
# Use #search_snippet instead for getting documentation snippets.

def search_record
return unless @parser < RDoc::Parser::Text

[
page_name,
'',
page_name,
'',
path,
'',
search_snippet,
]
end

##
# Returns an HTML snippet of the comment for search results.

Expand Down
4 changes: 1 addition & 3 deletions lib/rdoc/generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
##
# RDoc uses generators to turn parsed source code in the form of an
# RDoc::CodeObject tree into some form of output. RDoc comes with the HTML
# generator RDoc::Generator::Darkfish and an ri data generator
# generator RDoc::Generator::Aliki and an ri data generator
# RDoc::Generator::RI.
#
# == Registering a Generator
Expand Down Expand Up @@ -44,8 +44,6 @@ module RDoc::Generator
autoload :Markup, "#{__dir__}/generator/markup"

autoload :Aliki, "#{__dir__}/generator/aliki"
autoload :Darkfish, "#{__dir__}/generator/darkfish"
autoload :JsonIndex, "#{__dir__}/generator/json_index"
autoload :RI, "#{__dir__}/generator/ri"
autoload :POT, "#{__dir__}/generator/pot"

Expand Down
Loading