Skip to content

Commit cfc28b2

Browse files
committed
Mention community-maintained themes
1 parent 7fb0e50 commit cfc28b2

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.rdoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,33 @@ To determine how well your project is documented run <tt>rdoc -C lib</tt> to
110110
get a documentation coverage report. <tt>rdoc -C1 lib</tt> includes parameter
111111
names in the documentation coverage report.
112112

113+
== Theme Options
114+
115+
There are a few community-maintained themes for \RDoc:
116+
117+
- rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc]
118+
- hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans])
119+
120+
To use a theme:
121+
122+
- Add the theme to your Gemfile:
123+
124+
# Use require: false or put it in an appropriate group so it's not loaded by default
125+
gem 'theme-gem-name', require: false
126+
127+
- Tell \RDoc to use the theme by
128+
129+
- Setting the +--format+ option in your +.rdoc_options+ file:
130+
131+
--format=theme-name
132+
133+
- Setting the +generator+ option in your RDoc::Task:
134+
135+
RDoc::Task.new do |rdoc|
136+
rdoc.generator = 'theme-name'
137+
end
138+
139+
113140
== Bugs
114141

115142
See CONTRIBUTING@Bugs for information on filing a bug report. It's OK to file

0 commit comments

Comments
 (0)