Merge pull request #257 from realm/jp-custom-templates

[Templates] Added support for custom templates (addresses #20)

CHANGELOG.md

@@ -1,3 +1,21 @@
+## Master
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Added support for custom templates: use the `-t`/`--template-directory`
+  argument to jazzy.  
+  [JP Simard](https://github.com/jpsim)
+  [#20](https://github.com/realm/jazzy/issues/20)
+
+##### Bug Fixes
+
+* None.
+
+
 ## 0.2.1
 
 ##### Breaking

lib/jazzy/config.rb

@@ -2,6 +2,7 @@
 require 'pathname'
 require 'uri'
 
+require 'jazzy/doc'
 require 'jazzy/podspec_documenter'
 require 'jazzy/source_declaration/access_control_level'
 
@@ -29,6 +30,7 @@ class Config
     attr_accessor :docset_path
     attr_accessor :source_directory
     attr_accessor :excluded_files
+    attr_accessor :template_directory
 
     def initialize
       PodspecDocumenter.configure(self, Dir['*.podspec{,.json}'].first)
@@ -44,12 +46,18 @@ def initialize
       self.skip_undocumented = false
       self.source_directory = Pathname.pwd
       self.excluded_files = []
+      self.template_directory = Pathname(__FILE__).parent + 'templates'
     end
 
     def podspec=(podspec)
       @podspec = PodspecDocumenter.configure(self, podspec)
     end
 
+    def template_directory=(template_directory)
+      @template_directory = template_directory
+      Doc.template_path = template_directory
+    end
+
     # rubocop:disable Metrics/MethodLength
     def self.parse!
       config = new
@@ -161,6 +169,11 @@ def self.parse!
           config.source_directory = Pathname(source_directory)
         end
 
+        opt.on('t', '--template-directory DIRPATH', 'The directory that ' \
+               'contains the mustache templates to use') do |template_directory|
+          config.template_directory = Pathname(template_directory)
+        end
+
         opt.on('--readme FILEPATH',
                'The path to a markdown README file') do |readme|
           config.readme_path = Pathname(readme)

lib/jazzy/doc.rb

@@ -1,11 +1,12 @@
 require 'date'
 require 'pathname'
+require 'mustache'
 
 require 'jazzy/gem_version'
 
 module Jazzy
   class Doc < Mustache
-    self.template_path = Pathname(__FILE__).parent.parent
+    self.template_name = 'doc'
 
     def date
       # Fake date is used to keep integration tests consistent

lib/jazzy/doc.mustache → lib/jazzy/templates/doc.mustache

@@ -13,7 +13,7 @@
     <a name="//apple_ref/swift/{{dash_type}}/{{name}}" class="dashAnchor"></a>
     {{/dash_type}}
     <a title="{{name}} {{kind}} Reference"></a>
-    {{> jazzy/partials/header}}
+    {{> header}}
     <div class="content-wrapper">
       <p id="breadcrumbs">
         <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
@@ -22,16 +22,16 @@
       </p>
     </div>
     <div class="content-wrapper">
-      {{> jazzy/partials/nav}}
+      {{> nav}}
       <article class="main-content">
         <section>
           <section class="section">
             {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
             {{{overview}}}
           </section>
-          {{> jazzy/partials/tasks}}
+          {{> tasks}}
         </section>
-        {{> jazzy/partials/footer}}
+        {{> footer}}
       </article>
     </div>
   </body>

lib/jazzy/partials/task.mustache → lib/jazzy/templates/task.mustache

@@ -45,7 +45,7 @@
             <table class="graybox">
               <tbody>
                 {{#parameters}}
-                {{> jazzy/partials/parameter}}
+                {{> parameter}}
                 {{/parameters}}
               </tbody>
             </table>

lib/jazzy/partials/tasks.mustache → lib/jazzy/templates/tasks.mustache

@@ -1,7 +1,7 @@
 {{#tasks.count}}
 <section class="section task-group-section">
   {{#tasks}}
-  {{> jazzy/partials/task}}
+  {{> task}}
   {{/tasks}}
 </section>
 {{/tasks.count}}