Add --title option to set HTML document titles

skade · Jul 6, 2009 · 3684ff9 · 3684ff9
1 parent 87e150e
commit 3684ff9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/lib/yard/cli/yardoc.rb b/lib/yard/cli/yardoc.rb
@@ -146,6 +146,10 @@ def optparse(*args)
         opts.on('--no-highlight', "Don't highlight code in docs as Ruby.") do 
           options[:no_highlight] = true
         end
+
+        opts.on('--title TITLE', 'Add a specific title to HTML documents') do |title|
+          options[:title] = title
+        end
 
         opts.on('-r', '--readme FILE', 'The readme file used as the title page of documentation.') do |readme|
           raise Errno::ENOENT, readme unless File.file?(readme)

diff --git a/spec/cli/yardoc_spec.rb b/spec/cli/yardoc_spec.rb
@@ -9,6 +9,11 @@ class YARD::CLI::Yardoc; public :optparse end
     Registry.instance.stub!(:load)
   end
 
+  it "should accept --title" do
+    @yardoc.optparse('--title', 'hello world')
+    @yardoc.options[:title].should == :'hello world'
+  end
+
   it "should select a markup provider when --markup-provider or -mp is set" do
     @yardoc.optparse("-M", "test")
     @yardoc.options[:markup_provider].should == :test

diff --git a/templates/default/fulldoc/html/index.erb b/templates/default/fulldoc/html/index.erb
@@ -3,7 +3,7 @@
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-    <title>YARD Documentation</title>
+    <title><%= options[:title] || "YARD Documentation" %></title>
   </head>
   <frameset cols="20%,*">
     <frameset rows="13%,45%,42%">