docs 0.0.3 → 0.0.4

data/README.mdown

@@ -0,0 +1,60 @@
+# Docs
+Docs is a documentation generator for Ruby. It is intended for documenting things like HTTP APIs where the documentation doesn't make sense in the code.
+
+## Install
+
+```
+gem install docs
+```
+
+## Setup
+To setup Docs, run the following in an empty directory:
+
+```
+docs setup
+```
+
+It will create the following file structure:
+
+* docs/
+* examples/
+* config.yaml
+* application.erb
+
+The `docs` directory contains your documentation (written in Markdown, using the `.mdown` file extension), these are compiled to HTML at build time. The Markdown files are pre-processed with ERB, primarily so you can include your examples (up next).
+
+The `examples` directory contains the examples used within your code. They are stored as shell scripts written in either BASH or Ruby. Both the source of these files and the output when run is made available to your documentation files at build time. These are stored outside of the actual documentation so you can write tests for them. To include the source of an example named `examples/create_a_user.sh`:
+
+```erb
+<%= examples :source, 'examples/create_a_user.sh' %>
+```
+
+If you would like to show in your documentation the output of the bash script:
+
+```erb
+<%= examples :output, 'examples/create_a_user.sh' %>
+```
+
+The `config.yaml` file contains some config variables for Docs. Any variable set here is accessible within your documentation:
+
+```erb
+<%= config.template %>
+```
+
+If `template` is set in `config.yaml`, all markdown files will be compiled with `template` used as the template. Within template you can include the compiled Markdown:
+
+```erb
+<%= content %>
+```
+
+There are a few helpers made available to documentation files:
+
+* pretty_print_json(string) — This takes a JSON string and pretty prints it.
+* syntax_highlight(string, language) — Takes any piece of code and syntax highlights it with CodeRay, language is a Symbol representing one of CodeRay's supported languages.
+
+## Building
+To build a Docs project:
+
+```
+docs build
+```

data/lib/docs/project.rb

@@ -14,9 +14,9 @@ module Docs
       '.rb' => 'ruby'
     }
 
-    desc "setup [DIRECTORY]", "Creates a new Docs Project"
-    def setup(directory = '.')
-      nil 
+    desc "setup", "Creates a new Docs Project in current directory"
+    def setup
+      directory('template', '.')
     end
 
     desc "build", "Builds the current directory as a docs project into './output'"
@@ -100,5 +100,9 @@ module Docs
       end
     end
 
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + '../../..')
+    end
+
   end
 end

data/lib/docs/version.rb

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

data/template/application.erb

@@ -0,0 +1 @@
+<%= content %>

data/template/config.yaml

@@ -0,0 +1,5 @@
+directories:
+  temp: tmp
+  output: output
+  assets: public
+template: application.erb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70177518374340 !ruby/object:Gem::Requirement
+  requirement: &70229066023880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70177518374340
+  version_requirements: *70229066023880
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70177518373840 !ruby/object:Gem::Requirement
+  requirement: &70229066023380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70177518373840
+  version_requirements: *70229066023380
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &70177518373380 !ruby/object:Gem::Requirement
+  requirement: &70229066022920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70177518373380
+  version_requirements: *70229066022920
 description: Documentation generator with support for including code examples and
   compiling them at compile time
 email:
@@ -55,7 +55,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- README.mdown
 - Rakefile
 - bin/docs
 - docs.gemspec
@@ -64,6 +64,11 @@ files:
 - lib/docs/erb_environment.rb
 - lib/docs/project.rb
 - lib/docs/version.rb
+- template/application.erb
+- template/config.yaml
+- template/docs/.empty_directory
+- template/examples/.empty_directory
+- template/public/.empty_directory
 homepage: ''
 licenses: []
 post_install_message: