autodoc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9ef350c9fbfa8f0c91c49ea5c5acb2a629c6523
-  data.tar.gz: 39392c1e2cf3561ce80697fdbcd9218fb84978ac
+  metadata.gz: bd24e8d72e6159b5a53d09b62ca7df7568bcc51d
+  data.tar.gz: c5f8e0065d345aec0b6f3a06916ef00b6388c993
 SHA512:
-  metadata.gz: e798ec5836925fe93635c501839d496097730c16bb3aca7687429f2ada856be3ecdce649e7aa30e9fd006c21e7ace1b9cfdafc08cb6b0baeef18e40305d8ef00
-  data.tar.gz: b2fe73a5cc1732fca123ebcad91f4c60935ac238fbae10727a2125d181a79114019fe0d935efc94cecb6609a7460eafb270e99c5947d481b2c18f2286bc395ac
+  metadata.gz: 8e72b89964e79487fa7a1f1863e16714dcacec81381c15bb80c20d2659726d23c83ff13e4030a6a47355ab855a89d533704e9962a4ee377ba0e6f457b3e78fa4
+  data.tar.gz: 38c1459ff3956ea43cb0e9b90c4d9aeaf5de07469d6c08717fc0f265b7a613511ece988016b8ae0a2f354f21f168758a78c0104aec7611aca9031cf33a489490

data/README.md

@@ -60,31 +60,35 @@ response:
 </pre>
 
 ## Custom template
-You can customize autodoc's template ([Example](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/document.rb#L126-L139)).
+You can customize autodoc's template ([Example](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/configuration.rb#L18-L33)).  
 Here are avilable variables:
 
 * description
+* example
 * method
 * parameters_section
 * path
+* request
 * request_body_section
+* response
 * response_body
 * response_headers
 * response_status
 
+### Example
 <pre>
 Autodoc.configuration.template = &lt;&lt;-EOF
-  ## &lt;%= request.method %&gt; &lt;%= path %&gt;
-  &lt;%= example.description.capitalize %&gt;.
+  ## &lt;%= method %&gt; &lt;%= path %&gt;
+  &lt;%= description %&gt;
   &lt;%= parameters_section %&gt;
   ### request
   ```
-  &lt;%= request.method %&gt; &lt;%= request.path %&gt;
+  &lt;%= method %&gt; &lt;%= path %&gt;
   ```
   &lt;%= request_body_section %&gt;
   ### response
   ```ruby
-  Status: &lt;%= response.status %&gt;&lt;%= headers %&gt;
+  Status: &lt;%= response_status %&gt;&lt;%= response_headers %&gt;
   response: &lt;%= response_body %&gt;
   ```
 

data/lib/autodoc/document.rb

@@ -14,7 +14,7 @@ module Autodoc
     end
 
     def render
-      ERB.new(Autodoc.configuration.template).result(binding)
+      ERB.new(Autodoc.configuration.template, nil, "-").result(binding)
     end
 
     private

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura