Permalink
Browse files

shuffling files

  • Loading branch information...
1 parent 6709561 commit 2b205ec341356c40ed755ea9f737db053fa8639d @GBH GBH committed Aug 23, 2012
View
@@ -1,18 +1,15 @@
# API docs
-A tool to help you generate documentation for you API
+A tool to help you generate documentation for you API using integration tests in Rails 3.
## Installation
-
-Add gem definition to your Gemfile:
+Add gem definition to your Gemfile and `bundle install`:
-``` ruby
-gem 'api_docs'
-```
+ gem 'api_docs'
-Bundle it:
-
- bundle install
+To access generated docs mount it to a path in your `routes.rb` like this:
+
+ mount ApiDocs::Engine => '/api-docs'
Add [Twitter bootstrap](http://twitter.github.com/bootstrap) and [Google code pretifyer](http://google-code-prettify.googlecode.com/svn/trunk/README.html) to you CSS manifest file
@@ -1,5 +1,3 @@
-require_dependency "api_docs/application_controller"
-
class ApiDocs::DocsController < ApplicationController
def index
@api_controllers = { }
@@ -2,8 +2,8 @@
<html>
<head>
<title>Dummy</title>
- <%= stylesheet_link_tag "application", 'api_docs/application', :media => "all" %>
- <%= javascript_include_tag "application", 'api_docs/application' %>
+ <%= stylesheet_link_tag 'application', 'api_docs', :media => "all" %>
+ <%= javascript_include_tag 'application', 'api_docs' %>
<%= csrf_meta_tags %>
</head>
<body>

0 comments on commit 2b205ec

Please sign in to comment.