diff --git a/README.rdoc b/README.rdoc index 5a698edc88..68be7b0b1b 100644 --- a/README.rdoc +++ b/README.rdoc @@ -110,6 +110,33 @@ To determine how well your project is documented run rdoc -C lib to get a documentation coverage report. rdoc -C1 lib includes parameter names in the documentation coverage report. +== Theme Options + +There are a few community-maintained themes for \RDoc: + +- rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc] +- hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans]) + +To use a theme: + +- Add the theme to your Gemfile: + + # Use require: false or put it in an appropriate group so it's not loaded by default + gem 'theme-gem-name', require: false + +- Configure \RDoc to use the theme by either: + + - Setting the +--format+ option in your +.rdoc_options+ file: + + --format=theme-name + + - Setting the +generator+ option in your RDoc::Task: + + RDoc::Task.new do |rdoc| + rdoc.generator = 'theme-name' + end + + == Bugs See CONTRIBUTING@Bugs for information on filing a bug report. It's OK to file