apitome 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjBhMmIwYWE5MTk1ODg5Njg3Zjg3ZTYyZGZlNjMxNmZkYjkxODEwNg==
-  data.tar.gz: !binary |-
-    YmZlY2NjYzczOTZlNmQ1YWVjZDhhYWRmNWIzMTc4N2IwOTE4NDY1YQ==
+SHA1:
+  metadata.gz: 6502d6ca822e5f389f6be9f1b7913376951416b4
+  data.tar.gz: 80618ed260d3b5aa3b0ef4e4089d3e84c45a4e58
 SHA512:
-  metadata.gz: !binary |-
-    OGQ4ZDQ3YjQyMzM2MjU0ZmQ0ZDkwNTVhOThjYTIwMTEzOTg4ZGRkMDdhNGFm
-    ODlkNDMyODlkZTIzNzEwM2E2MzBhNWM5MTNiM2E0YmFlZmY2ZmY2MjgzZmEz
-    ZDBiY2U1OTkwMjk3YmRkZDNiYzgxYWZkY2JiZjNjMjhiMjgzNGQ=
-  data.tar.gz: !binary |-
-    ODY2NWU2ZTlhNzhhNmNhMDkyZGQyOTg2ZjY4MDlhY2NkZDQ2ZjYyMjA2ZmRm
-    MTBkNTBjMDY1N2Y2OGU3ZWYxOGZkNDgwM2NjZjg5ZTM0OGFmNzRhNWQwM2Vm
-    NjMxNjc4Nzk0YzEzMjE1MmQ1OGMxMzBmNWYxMmQ1MGQ2YTdhNzY=
+  metadata.gz: 875c1000fae6914a076bb3540931381e06b29f80c257ba20dd8413b9687e7243d87660c86f0c8743592e53c6fc1969033ff22f26e6d0a6f7b673071e70034313
+  data.tar.gz: 5e3b4182023c665d3e4cecd6a2fd03315ee76db60fe788315affa10d84ca7efeab15c6f06a21eaf71a58d59d5738ca3eab944addd020748a962975aa9ecf4328

data/README.md

@@ -1,15 +1,114 @@
 Apitome
 =======
 
+[![Gem Version](https://badge.fury.io/rb/apitome.png)](http://badge.fury.io/rb/apitome)
+[![Code Climate](https://codeclimate.com/github/modeset/apitome.png)](https://codeclimate.com/github/modeset/apitome)
 
+Apitome is a documentation tool for Rails that enhances [rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation) (RAD). It's designed to display the documentation generated by RAD in either a single page (with scrollspy), or on individual pages, and uses Bootstrap3 for most of the basic styling and [highlight.js](https://github.com/isagalaev/highlight.js) for code highlighting.
+
+You can provide a markdown file that will be displayed as the README page, and by taking advantage of its modular view structure you can override any number of views and partials to customize the output. You can also specify custom css and javascript if you want to do fancier things or change how it looks.
+
+
+## Installation
+
+Add it to your Gemfile.
+
+```ruby
+gem "apitome"
+```
+
+Optionally run the install generator to get the initializer and an initial readme file (doc/api.md).
+
+```
+rails generate apitome:install
+```
+
+Update your `spec_helper.rb` to adjust how RAD outputs its results -- Apitome reads these JSON files to generate the documentation.
 
-`spec_helper.rb`
 ```ruby
 RspecApiDocumentation.configure do |config|
   config.format = :json
 end
 ```
 
+
+## Usage
+
+You can view your documentation at the default `api/docs` route.
+
+
+## Configuration
+
+<dl>
+
+<dt> mount_at </dt><dd>
+  This determines where the Apitome routes will be mounted. Changing this to "/api/documentation" for instance would allow you to browse to http://localhost:3000/api/documentation to see your api documentation. Set to nil and mount it yourself if you need to.<br/>
+
+  <b>default:</b> <code>"/api/docs"</code>
+</dd>
+
+<dt> root </dt><dd>
+  This defaults to Rails.root if left nil. If you're providing documentation for an engine using a dummy application it can be useful to set this to your engines root.. E.g. <code>Application::Engine.root</code><br/>
+
+  <b>default:</b> <code>nil</code>
+</dd>
+
+<dt> doc_path </dt><dd>
+  This is where rspec_api_documentation outputs the JSON files. This is configurable within RAD, and so is configurable here.<br/>
+
+  <b>default:</b> <code>"doc/api"</code>
+</dd>
+
+<dt> title </dt><dd>
+  The title of the documentation -- If your project has a name, you'll want to put it here.<br/>
+
+  <b>default:</b> <code>"Apitome Documentation"</code>
+</dd>
+
+<dt> layout </dt><dd>
+  The main layout view for all documentation pages. By default this is pretty basic, but you may want to use your own application layout.<br/>
+
+  <b>default:</b> <code>"apitome/application"</code>
+</dd>
+
+<dt> code_theme </dt><dd>
+  We're using [highlight.js](https://github.com/isagalaev/highlight.js) for code highlighting, and it comes with some great themes. You can check [here for themes](http://softwaremaniacs.org/media/soft/highlight/test.html), and enter the theme as lowercase/underscore.<br/>
+
+  <b>default:</b> <code>"default"</code>
+</dd>
+
+<dt> css_override </dt><dd>
+  This allows you to override the css manually. You typically want to require `apitome/application` within the override, but if you want to override it entirely you can do so.<br/>
+
+  <b>default:</b> <code>nil</code>
+</dd>
+
+<dt> js_override </dt><dd>
+  This allows you to override the javascript manually. You typically want to require `apitome/application` within the override, but if you want to override it entirely you can do so.<br/>
+
+  <b>default:</b> <code>nil</code>
+</dd>
+
+<dt> readme </dt><dd>
+  You can provide a "README" style markdown file for the documentation, which is a useful place to include general information. This path is relative to your doc_path configuration.<br/>
+
+  <b>default:</b> <code>"../api.md"</code>
+</dd>
+
+<dt> single_page </dt><dd>
+  Apitome can render the documentation into a single page that uses scrollspy, or it can render the documentation on individual pages on demand. This allows you to specify which one you want, as a single page may impact performance.<br/>
+
+  <b>default:</b> <code>true</code>
+</dd>
+
+
+## Customization
+
+You can put custom views and partials in your own `views/apitome/docs` -- check the repo here for [examples](https://github.com/modeset/apitome/tree/master/app/views/apitome/docs). You can put any partial in your own path and they will be overridden.
+
+Additional customization can come in the form of providing custom css and javascript. You can do this by creating the files you want (that often times require the default assets in the gem), and then configure Apitome to use those instead of the defaults.
+
+
 ## License
 
 Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)

data/lib/apitome/engine.rb

@@ -9,8 +9,10 @@ module Apitome
 
     config.after_initialize do |app|
       # prepend routes so a catchall doesn't get in the way
-      app.routes.prepend do
-        mount Apitome::Engine => Apitome.configuration.mount_at
+      if Apitome.configuration.mount_at.present?
+        app.routes.prepend do
+          mount Apitome::Engine => Apitome.configuration.mount_at
+        end
       end
     end
 

data/lib/apitome/version.rb

@@ -1,3 +1,3 @@
 module Apitome
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/generators/apitome/install/POST_INSTALL

@@ -0,0 +1,4 @@
++============================================================================+
+Congratulations! Apitome was successfully installed.
+
+Documentation and more can be found at: https://github.com/modeset/apitome

data/lib/generators/apitome/install/install_generator.rb

@@ -0,0 +1,19 @@
+module Apitome
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../", __FILE__)
+
+      desc "Installs the Apitome initializer and markdown file into your application."
+
+      def copy_initializers
+        copy_file "templates/initializer.rb", "config/initializers/apitome.rb"
+        copy_file "templates/api.md", "doc/api.md"
+      end
+
+      def display_readme
+        readme "POST_INSTALL" if behavior == :invoke
+      end
+
+    end
+  end
+end

data/lib/generators/apitome/install/templates/api.md

@@ -0,0 +1,4 @@
+Apitome Documentation
+=====================
+
+This file was automatically generated, and can be found at `doc/api.md`.

data/lib/generators/apitome/install/templates/initializer.rb

@@ -0,0 +1,44 @@
+Apitome.setup do |config|
+
+  # This determines where the Apitome routes will be mounted. Changing this to "/api/documentation" for instance would
+  # allow you to browse to http://localhost:3000/api/documentation to see your api documentation. Set to nil and mount
+  # it yourself if you need to.
+  config.mount_at = "/api/docs"
+
+  # This defaults to Rails.root if left nil. If you're providing documentation for an engine using a dummy application
+  # it can be useful to set this to your engines root.. E.g. Application::Engine.root
+  config.root = nil
+
+  # This is where rspec_api_documentation outputs the JSON files. This is configurable within RAD, and so is
+  # configurable here.
+  config.doc_path = 'doc/api'
+
+  # The title of the documentation -- If your project has a name, you'll want to put it here.
+  config.title = 'Apitome Documentation'
+
+  # The main layout view for all documentation pages. By default this is pretty basic, but you may want to use your own
+  # application layout.
+  config.layout = 'apitome/application'
+
+  # We're using highlight.js (https://github.com/isagalaev/highlight.js) for code highlighting, and it comes with some
+  # great themes. You can check http://softwaremaniacs.org/media/soft/highlight/test.html for themes, and enter the
+  # theme as lowercase/underscore.
+  config.code_theme = 'default'
+
+  # This allows you to override the css manually. You typically want to require `apitome/application` within the
+  # override, but if you want to override it entirely you can do so.
+  config.css_override = nil
+
+  # This allows you to override the javascript manually. You typically want to require `apitome/application` within the
+  # override, but if you want to override it entirely you can do so.
+  config.js_override = nil
+
+  # You can provide a "README" style markdown file for the documentation, which is a useful place to include general
+  # information. This path is relative to your doc_path configuration.
+  config.readme = '../api.md'
+
+  # Apitome can render the documentation into a single page that uses scrollspy, or it can render the documentation on
+  # individual pages on demand. This allows you to specify which one you want, as a single page may impact performance.
+  config.single_page = true
+
+end

data/spec/dummy/config/initializers/apitome.rb

@@ -1,6 +1,44 @@
 Apitome.setup do |config|
 
-  #config.root = Apitome::Engine.root
+  # This determines where the Apitome routes will be mounted. Changing this to "/api/documentation" for instance would
+  # allow you to browse to http://localhost:3000/api/documentation to see your api documentation. Set to nil and mount
+  # it yourself if you need to.
+  config.mount_at = "/api/docs"
+
+  # This defaults to Rails.root if left nil. If you're providing documentation for an engine using a dummy application
+  # it can be useful to set this to your engines root.. E.g. Application::Engine.root
+  config.root = nil
+
+  # This is where rspec_api_documentation outputs the JSON files. This is configurable within RAD, and so is
+  # configurable here.
+  config.doc_path = 'doc/api'
+
+  # The title of the documentation -- If your project has a name, you'll want to put it here.
+  config.title = 'Apitome Documentation'
+
+  # The main layout view for all documentation pages. By default this is pretty basic, but you may want to use your own
+  # application layout.
+  config.layout = 'apitome/application'
+
+  # We're using highlight.js (https://github.com/isagalaev/highlight.js) for code highlighting, and it comes with some
+  # great themes. You can check http://softwaremaniacs.org/media/soft/highlight/test.html for themes, and enter the
+  # theme as lowercase/underscore.
+  config.code_theme = 'default'
+
+  # This allows you to override the css manually. You typically want to require `apitome/application` within the
+  # override, but if you want to override it entirely you can do so.
+  config.css_override = nil
+
+  # This allows you to override the javascript manually. You typically want to require `apitome/application` within the
+  # override, but if you want to override it entirely you can do so.
+  config.js_override = nil
+
+  # You can provide a "README" style markdown file for the documentation, which is a useful place to include general
+  # information. This path is relative to your doc_path configuration.
+  config.readme = '../api.md'
+
+  # Apitome can render the documentation into a single page that uses scrollspy, or it can render the documentation on
+  # individual pages on demand. This allows you to specify which one you want, as a single page may impact performance.
   config.single_page = true
 
 end

data/spec/dummy/log/development.log

@@ -18073,3 +18073,218 @@ Started GET "/assets/apitome/application.css?body=1" for 127.0.0.1 at 2013-10-03
 
 
 Started GET "/assets/apitome/application.js?body=1" for 127.0.0.1 at 2013-10-03 10:51:34 -0600
+
+
+Started GET "/api/docs" for 127.0.0.1 at 2013-10-08 23:43:23 -0600
+Processing by Apitome::DocsController#index as HTML
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_explanation.html.erb (0.5ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.8ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (10.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (2.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_query.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (4.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_all_examples.html.erb (21.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/index.html.erb within layouts/apitome/application (26.8ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_header.html.erb (0.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_navigation.html.erb (1.0ms)
+Completed 200 OK in 98ms (Views: 98.1ms)
+
+
+Started GET "/assets/apitome/bootstrap.min.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/jquery-2.0.3.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/highlight_themes/default.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/bootstrap.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/highlight.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/application.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/application.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/api/docs" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+Processing by Apitome::DocsController#index as HTML
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_explanation.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (3.6ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (2.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_query.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (3.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_all_examples.html.erb (10.9ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/index.html.erb within layouts/apitome/application (11.6ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_header.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_navigation.html.erb (0.4ms)
+Completed 200 OK in 15ms (Views: 14.7ms)
+
+
+Started GET "/assets/apitome/highlight_themes/default.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/bootstrap.min.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/application.css?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/jquery-2.0.3.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/bootstrap.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/highlight.min.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/assets/apitome/application.js?body=1" for 127.0.0.1 at 2013-10-08 23:43:24 -0600
+
+
+Started GET "/api/docs" for 127.0.0.1 at 2013-10-09 00:19:50 -0600
+Processing by Apitome::DocsController#index as HTML
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_explanation.html.erb (0.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.8ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (9.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (2.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_query.html.erb (0.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (4.6ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_all_examples.html.erb (21.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/index.html.erb within layouts/apitome/application (26.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_header.html.erb (0.5ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_navigation.html.erb (1.4ms)
+Completed 200 OK in 80ms (Views: 79.9ms)
+
+
+Started GET "/assets/apitome/bootstrap.min.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/highlight_themes/default.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/application.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/jquery-2.0.3.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/bootstrap.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/highlight.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/application.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/api/docs" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+Processing by Apitome::DocsController#index as HTML
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_explanation.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.3ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (5.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (2.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_params.html.erb (0.2ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_route.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_query.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_status.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_headers.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_body.html.erb (0.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_example.html.erb (3.1ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_all_examples.html.erb (13.8ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/index.html.erb within layouts/apitome/application (15.4ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_header.html.erb (0.0ms)
+  Rendered /Users/jejacks0n/Projects/apitome/app/views/apitome/docs/_navigation.html.erb (0.4ms)
+Completed 200 OK in 19ms (Views: 18.9ms)
+
+
+Started GET "/assets/apitome/bootstrap.min.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/highlight_themes/default.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/jquery-2.0.3.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/application.css?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/highlight.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/bootstrap.min.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/application.js?body=1" for 127.0.0.1 at 2013-10-09 00:19:51 -0600
+
+
+Started GET "/assets/apitome/jquery-2.0.3.min.js" for 127.0.0.1 at 2013-10-09 00:19:51 -0600

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: apitome
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - jejacks0n
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.5
     - - <
@@ -24,7 +24,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.5
     - - <
@@ -34,28 +34,28 @@ dependencies:
   name: rspec_api_documentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: github-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: API documentation renderer for Rails using RSpec API Documentation JSON
@@ -90,6 +90,10 @@ files:
 - lib/apitome/exceptions.rb
 - lib/apitome/version.rb
 - lib/apitome.rb
+- lib/generators/apitome/install/install_generator.rb
+- lib/generators/apitome/install/POST_INSTALL
+- lib/generators/apitome/install/templates/api.md
+- lib/generators/apitome/install/templates/initializer.rb
 - vendor/assets/javascripts/apitome/bootstrap.min.js
 - vendor/assets/javascripts/apitome/bootstrap.min.LICENSE
 - vendor/assets/javascripts/apitome/highlight.min.js
@@ -117,11 +121,11 @@ files:
 - vendor/assets/stylesheets/apitome/highlight_themes/solarized_dark.css
 - vendor/assets/stylesheets/apitome/highlight_themes/solarized_light.css
 - vendor/assets/stylesheets/apitome/highlight_themes/sunburst.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-blue.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-bright.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night-eighties.css
-- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow-night.css
 - vendor/assets/stylesheets/apitome/highlight_themes/tomorrow.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_blue.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_bright.css
+- vendor/assets/stylesheets/apitome/highlight_themes/tomorrow_night_eighties.css
 - vendor/assets/stylesheets/apitome/highlight_themes/vs.css
 - vendor/assets/stylesheets/apitome/highlight_themes/xcode.css
 - vendor/assets/stylesheets/apitome/highlight_themes/zenburn.css
@@ -151,6 +155,8 @@ files:
 - spec/dummy/tmp/cache/assets/development/sprockets/07b6695ed44671a8d213823bc763b378
 - spec/dummy/tmp/cache/assets/development/sprockets/0f10ed0a447d44a80afcc427e858ddf1
 - spec/dummy/tmp/cache/assets/development/sprockets/3c0d7839d05fa6264e540e4612e76d8e
+- spec/dummy/tmp/cache/assets/development/sprockets/51da1b3982537bb7f98b971e3f9c45f1
+- spec/dummy/tmp/cache/assets/development/sprockets/53ba3c64ee4d340ffd21feaab8cc579a
 - spec/dummy/tmp/cache/assets/development/sprockets/54ddec13d8230a77be44f49bba9ab063
 - spec/dummy/tmp/cache/assets/development/sprockets/82a9467461d6cbd74f0c38002037d366
 - spec/dummy/tmp/cache/assets/development/sprockets/82b46b5876ec191ffb4ee1f73b9037cf
@@ -160,6 +166,7 @@ files:
 - spec/dummy/tmp/cache/assets/development/sprockets/8eb01b8f553b48d4712bc6df728f05ed
 - spec/dummy/tmp/cache/assets/development/sprockets/98be05ccb93e3f09cd213ad66be4afd5
 - spec/dummy/tmp/cache/assets/development/sprockets/a4636c23002ad75a90567e067a4a87b2
+- spec/dummy/tmp/cache/assets/development/sprockets/a47d2ddd9c0e1b87d20a911bb1c92651
 - spec/dummy/tmp/cache/assets/development/sprockets/a7dbf6dc1b06132961af53b0dc4bd187
 - spec/dummy/tmp/cache/assets/development/sprockets/b7fc26490932e9ef364d72f46116f29a
 - spec/dummy/tmp/cache/assets/development/sprockets/d9052716353aa1cde34614ee79e75fc2
@@ -176,20 +183,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.3
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
-summary: ! 'Apitome: /iˈpitəmē/ An API documentation reader RSpec API Documentation'
+summary: 'Apitome: /iˈpitəmē/ An API documentation reader RSpec API Documentation'
 test_files:
 - spec/apitome/configuration_spec.rb
 - spec/apitome/engine_spec.rb
@@ -215,6 +222,8 @@ test_files:
 - spec/dummy/tmp/cache/assets/development/sprockets/07b6695ed44671a8d213823bc763b378
 - spec/dummy/tmp/cache/assets/development/sprockets/0f10ed0a447d44a80afcc427e858ddf1
 - spec/dummy/tmp/cache/assets/development/sprockets/3c0d7839d05fa6264e540e4612e76d8e
+- spec/dummy/tmp/cache/assets/development/sprockets/51da1b3982537bb7f98b971e3f9c45f1
+- spec/dummy/tmp/cache/assets/development/sprockets/53ba3c64ee4d340ffd21feaab8cc579a
 - spec/dummy/tmp/cache/assets/development/sprockets/54ddec13d8230a77be44f49bba9ab063
 - spec/dummy/tmp/cache/assets/development/sprockets/82a9467461d6cbd74f0c38002037d366
 - spec/dummy/tmp/cache/assets/development/sprockets/82b46b5876ec191ffb4ee1f73b9037cf
@@ -224,6 +233,7 @@ test_files:
 - spec/dummy/tmp/cache/assets/development/sprockets/8eb01b8f553b48d4712bc6df728f05ed
 - spec/dummy/tmp/cache/assets/development/sprockets/98be05ccb93e3f09cd213ad66be4afd5
 - spec/dummy/tmp/cache/assets/development/sprockets/a4636c23002ad75a90567e067a4a87b2
+- spec/dummy/tmp/cache/assets/development/sprockets/a47d2ddd9c0e1b87d20a911bb1c92651
 - spec/dummy/tmp/cache/assets/development/sprockets/a7dbf6dc1b06132961af53b0dc4bd187
 - spec/dummy/tmp/cache/assets/development/sprockets/b7fc26490932e9ef364d72f46116f29a
 - spec/dummy/tmp/cache/assets/development/sprockets/d9052716353aa1cde34614ee79e75fc2