File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed
Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change 11= \RDoc - Ruby Documentation System
2+ c
23
34home :: https://github.com/ruby/rdoc
45rdoc :: https://ruby.github.io/rdoc
@@ -110,6 +111,33 @@ To determine how well your project is documented run <tt>rdoc -C lib</tt> to
110111get a documentation coverage report. <tt>rdoc -C1 lib</tt> includes parameter
111112names in the documentation coverage report.
112113
114+ == Theme Options
115+
116+ There are a few community-maintained themes for \RDoc:
117+
118+ - rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc]
119+ - hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans])
120+
121+ To use a theme:
122+
123+ - Add the theme to your Gemfile:
124+
125+ # Use require: false or put it in an appropriate group so it's not loaded by default
126+ gem 'theme-gem-name', require: false
127+
128+ - Tell \RDoc to use the theme by
129+
130+ - Setting the +--format+ option in your +.rdoc_options+ file:
131+
132+ --format=theme-name
133+
134+ - Setting the +generator+ option in your RDoc::Task:
135+
136+ RDoc::Task.new do |rdoc|
137+ rdoc.generator = 'theme-name'
138+ end
139+
140+
113141== Bugs
114142
115143See CONTRIBUTING@Bugs for information on filing a bug report. It's OK to file
You can’t perform that action at this time.
0 commit comments