Skip to content

Commit

Permalink
Rename development script make it more obvious
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisbernard committed Oct 17, 2024
1 parent e689722 commit df43f18
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ If you want to use this theme in your documentation:
gem install rorvswild_theme_rdoc
# Generate the documentation
rdoc --root path/to/source/code --template=rorvswild
rdoc --root path/to/source/code --template rorvswild
```

## Development

Call the custom `rdoc.rb` script which automatically loads RoRvsWild's theme.
Call the custom `rorvswild-theme-rdoc` script which automatically loads RoRvsWild's theme.

```
./rdoc.rb --root path/to/source/code --template rorvswild
./rorvswild-theme-rdoc --root path/to/source/code
```
1 change: 1 addition & 0 deletions rdoc.rb → rorvswild-theme-rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
require "rdoc"
require "rorvswild_theme_rdoc"

ARGV << "--template=rorvswild"
RDoc::RDoc.new.document(ARGV)

0 comments on commit df43f18

Please sign in to comment.