padrino-apidoc 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd35a498c1c7b20bc693cd15e2fe87b6d443226
-  data.tar.gz: ec5d76af295e75e4863ac8108d320ab2174348ea
+  metadata.gz: 0acc216029e5da3a75ca42d7c8fa94caa6e88cd9
+  data.tar.gz: fbd304c036cb03a25c2356a26afdceb4259ccc90
 SHA512:
-  metadata.gz: 5461b336311bf0724f462efcdbb5cc26e15e2ee612262bf084214eade50979d47bf9ab23357f7317bdcbd69f44d7163860250adfcd569c4da3616bfe65b953c5
-  data.tar.gz: cc595dd0590572bc1916a1adb74dc5547618a0e9871a7195323d77f31b325d489a9e15fc802fa5cae702c9a2762d784269b002ff0a19ab9d2e98fc62f593510a
+  metadata.gz: 97702e848c83461eab93adc3a558af70ad6915b40357abcf9de8ccdaf7361171ebb25b25aadca0fb4cbc4b134051340925b9393a94056cf2cb8e645936b47bf5
+  data.tar.gz: 8d613215123b19d3d79c5b00a804079f2fae36957db298c7f746008d798a8b059825674360f7e7d26067c6fea051dec5a0e8e261d45125c7b0b8ffb0d3da2a77

data/CHANGELOG

@@ -1,3 +1,8 @@
+*0.0.5* (February 19, 2014)
+
+* Updated docs to reflect how to setup views
+* updated midwire-common gem version
+
 *0.0.4* (December 31, 2013)
 
 * Fixed section rendering

data/README.md

@@ -23,6 +23,10 @@ Or install it yourself as:
 
 ## Usage
 
+### Templates
+
+Copy the 'views' directory in this gem to your PADRINO_ROOT/config directory. Feel free to edit the HAML view templates as you see fit.
+
 ### Documentation Syntax
 
     ## Section Name
@@ -48,10 +52,14 @@ Or install it yourself as:
     #     "workers":    0
     #   }
 
+### Mounting the Sub-App
+
 At the end of your config/apps.rb file:
 
     Padrino.mount('Padrino::Apidoc::App').to('/docs')
 
+### Viewing Docs
+
 Navigate to 'localhost:9292/docs' or whatever hostname/port you are running on.
 
 ## Contributing

data/lib/padrino/apidoc/version.rb

@@ -1,5 +1,5 @@
 module Padrino
   module Apidoc
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   end
 end

data/padrino-apidoc.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "midwire_common", '~> 0.1.6'
+  spec.add_development_dependency "midwire_common", '~> 0.1.7'
 
   spec.add_dependency 'padrino'
 end

data/views/docs.sass

@@ -0,0 +1,107 @@
+*
+  :font-family Helvetica, Arial, sans-serif
+
+=code_title
+  :display block
+  :padding 6px 10px
+  :font-weight bold
+  :background #ccc
+  :color #333
+  :margin-left -12px
+  :margin-right -12px
+  :margin-top -12px
+  :margin-bottom 12px
+
+h2
+  :background #555
+  :color #fff
+  :border 1px #666 solid
+  :padding 10px
+  a
+    :color #fff
+    :text-decoration none
+
+.api
+  :margin-bottom 24px
+  :background #eee
+  :border 1px #ccc solid
+
+  .url
+    :padding 6px 10px
+    :background #aaa
+    :border-bottom 1px #ccc solid
+    a
+      :color #333
+      :font-size 1.6em
+      :font-weight bold
+      :font-family monospace
+
+  .description
+    :padding 12px
+
+  code
+    :font-family Monaco, monospace
+    :white-space pre
+    :padding 12px
+    :display block
+    :overflow auto
+
+  .params
+    :margin-bottom 10px
+    :padding 12px
+    :display block
+    &:before
+      +code_title
+      :content "Parameters"
+    .param
+      :line-height 30px
+      .name
+        :display inline
+        :font-weight bold
+        :font-family monospace
+        :font-size 1.2em
+      .type
+        :font-weight bold
+        :font-size 0.6em
+        :color #999
+        :display inline-block
+        :width 65px
+      .required
+        :color #333
+      .description
+        :display inline
+
+  .request
+    &:before
+      +code_title
+      :content "Request"
+
+  .response
+    &:before
+      +code_title
+      :content "Response"
+
+body
+  :margin 0
+
+#content
+  :width 800px
+  :margin-left auto
+  :margin-right auto
+
+#index
+  .section
+    :margin-bottom 20px
+  .summarydoc
+    :border 1px #ccc solid
+    :padding 12px
+    :margin-top 10px
+    :background #eee
+    .path
+      :margin-bottom 10px
+      a
+        :font-family monospace
+        :font-weight bold
+        :font-size 1.4em
+    .description
+      :color #666

data/views/index.haml

@@ -0,0 +1,13 @@
+#index
+  - sections.each do |section|
+
+    .section
+      %h2
+        %a{ :href => "/docs/#{urlize_section(section)}" }= section
+
+      - docs_in_section(docs, urlize_section(section)).each_with_index do |method, index|
+        .summarydoc
+          .path
+            %a{ :href => "/docs/#{urlize_section(section)}##{index}" }
+              = "#{method[:verb].upcase} #{method[:uri]}"
+          .description= method[:description]

data/views/layouts/apidoc.haml

@@ -0,0 +1,16 @@
+!!! 5
+
+%html
+
+  %head
+    %title API Documentation
+    %link{ :rel => "stylesheet", :href => "/docs/docs.css" }
+
+  %body
+
+    #content
+
+      %h1
+        %a{ :href => '/docs' } API Documentation
+
+      = yield

data/views/section.haml

@@ -0,0 +1,28 @@
+%h2= section
+
+- docs.each_with_index do |doc, index|
+
+  .api
+
+    .url
+      %a{ :name => index }
+        = doc[:verb].upcase
+        = doc[:uri]
+
+    .description
+      = doc[:description]
+
+    - if (doc[:params] || []).length > 0
+      .params
+        - doc[:params].each do |param|
+          .param
+            .type{ :class => (param[:required] && "required") }
+              = (param[:required]) ? "REQUIRED" : "OPTIONAL"
+            .name= escape_html(param[:name])
+            .description= param[:description]
+
+    %code.request
+      = code doc[:request]
+
+    %code.response
+      = code doc[:response]

data/views/toc.haml

@@ -0,0 +1,4 @@
+%ul#toc
+
+  - sections.each do |section|
+    = doc urlize_section(section), section

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: padrino-apidoc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Chris Blackburn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: padrino
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,11 @@ files:
 - lib/padrino/apidoc/parser.rb
 - lib/padrino/apidoc/version.rb
 - padrino-apidoc.gemspec
+- views/docs.sass
+- views/index.haml
+- views/layouts/apidoc.haml
+- views/section.haml
+- views/toc.haml
 homepage: ''
 licenses:
 - MIT