double_doc 1.0.4 → 1.0.5

data/{readme.md → README.md}

@@ -7,7 +7,9 @@ This is the problem DoubleDoc tries to solve.
 
 DoubleDoc allows you to write the documentation right where your code is, and you can combine it all into a well structured document.
 
-### Format
+This document was generated using DoubleDoc, and the source of this project is a great source for inspiration for how to use DoubleDoc.
+
+### Documentation Format
 You write your documentation in markdown right in your source code files by double commenting it:
 
 ```ruby
@@ -63,14 +65,53 @@ And DoubleDoc will generate this markdown document for you:
     ```
 
 ### Rake Task
+It is very easy to set up a rake task for generating your documentation. All you have to do is
+tell DoubleDoc what the input files are, and where you want the output to go.
+
+```ruby
+require 'double_doc'
+
+DoubleDoc::Task.new(:doc,
+  :sources          => 'doc/source/*.md',
+  :md_destination   => 'doc/generated',
+  :html_destination => 'site'
+)
+```
+
+The available options are:
+
+| name                 | Description
+| -------------------- | -----------
+| __sources__          | __Required__. This tells Double doc where to look for the source of the documentation. Can be either a string or an array of strings.
+| __md_destination__   | __Required__. This is the directory where you want the generated markdown files to go.
+| __html_destination__ | If you want a pretty HTML version of your documentation, all you have to do is to say where you want it.
+| __html_template__    | You can use your own custom ERB template for HTML rendering. Have a look in the one we ship with DoubleDoc for inspiration (templates/default.html.erb).
+| __html_renderer__    | If you want full control of the HTML rendering you can use your own implementation. Defaults to `DoubleDoc::HtmlRenderer`.
+| __html_css__         | You can use your own custom CSS document by specifying it's path here.
+| __title__            | The title you want in the generated HTML. Defaults to "Documentation".
+
+If you just want to use double doc to generate your readme.md for github, you should write your documentation in doc/readme.md and put his in your Rakefile:
+
+```ruby
+require 'double_doc'
+
+DoubleDoc::Task.new(:doc, :sources => 'doc/readme.md', :md_destination => '.')
+```
+Then all you have to do is to run `rake doc`, and you will have a `readme.md` in the root of your project.
+
+You can even run `rake doc:publish` to generate html documentation and push it to your Github Pages.
+
+### Notes
+DoubleDoc is tested as working on both ruby 1.8.7 and 1.9.3, but does not work on jruby because if it's dependency on redcarpet.
 
-You can easly use DoubleDoc from Rake, and soon I'll tell you how...
+[![Build Status](https://secure.travis-ci.org/staugaard/double_doc.png?branch=master)](http://travis-ci.org/staugaard/double_doc)
 
 ### TODO
 * Tests
 * Support for directory structures
 * Documentation for the Rake task
 * Documentation for the Guard
+* Add support for extracting documentation from JavaScript files
 
 ### License
 #### The MIT License

data/lib/double_doc/doc_extractor.rb

@@ -1,35 +1,48 @@
 module DoubleDoc
   class DocExtractor
-    def self.extract(source)
+    TYPES = {
+      'rb' => /\s*##\s?(.*)$/
+      }.freeze
+
+    def self.extract(source, options = {})
       case source
       when String
-        extract_from_lines(source.split("\n"))
+        extract_from_lines(source.split("\n"), options)
       when File
-        extract_from_lines(source.readlines)
+        if type = File.extname(source.path)
+          type = type[1..-1]
+        end
+        type ||= 'rb'
+
+        extract_from_lines(source.readlines, options.merge(:type => type))
       when Array
-        extract_from_lines(source)
+        extract_from_lines(source, options)
       else
         raise "can't extract docs from #{source}"
       end
     end
 
-    def self.extract_from_lines(lines)
+    def self.extract_from_lines(lines, options)
       doc = []
+      extractor = TYPES[options[:type]]
+
       add_empty_line = false
       lines.each do |line|
-        if match = line.match(/\s*##\s?(.*)$/)
+        if match = line.match(extractor)
           if add_empty_line
             doc << ''
             add_empty_line = false
           end
           doc << match[1].rstrip
         else
-          add_empty_line = true
+          add_empty_line = !doc.empty?
         end
       end
 
       return '' if doc.empty? || doc.all?(&:empty?)
 
+      doc << ''
+
       return doc.join("\n")
     end
   end

data/lib/double_doc/html_generator.rb

@@ -28,7 +28,6 @@ module DoubleDoc
             :title         => @title,
             :body          => body,
             :css           => @stylesheet,
-            :highlight_css => @html_renderer.stylesheet,
             :sitemap       => sitemap
           )
           out.write(html)

data/lib/double_doc/html_renderer.rb

@@ -5,7 +5,7 @@ module DoubleDoc
   class HtmlRenderer
 
     def self.render(text)
-      markdown = Redcarpet::Markdown.new(RedcarpetRenderer, :fenced_code_blocks => true)
+      markdown = Redcarpet::Markdown.new(RedcarpetRenderer, :fenced_code_blocks => true, :no_intra_emphasis => true, :tables => true)
       markdown.render(text)
     end
 
@@ -13,10 +13,6 @@ module DoubleDoc
       text.strip.downcase.gsub(/\s+/, '-')
     end
 
-    def self.stylesheet
-      Pygments.css('.highlight')
-    end
-
     class RedcarpetRenderer < Redcarpet::Render::HTML
       def header(text, level)
         "<h#{level} id=\"#{DoubleDoc::HtmlRenderer.generate_id(text)}\">#{text}</h#{level}>"

data/lib/double_doc/task.rb

@@ -1,10 +1,46 @@
+require 'rake'
 require 'pathname'
 require 'double_doc/import_handler'
 require 'double_doc/html_generator'
 
 module DoubleDoc
 
-  ## You can easly use DoubleDoc from Rake, and soon I'll tell you how...
+  ## ### Rake Task
+  ## It is very easy to set up a rake task for generating your documentation. All you have to do is
+  ## tell DoubleDoc what the input files are, and where you want the output to go.
+  ##
+  ## ```ruby
+  ## require 'double_doc'
+  ##
+  ## DoubleDoc::Task.new(:doc,
+  ##   :sources          => 'doc/source/*.md',
+  ##   :md_destination   => 'doc/generated',
+  ##   :html_destination => 'site'
+  ## )
+  ## ```
+  ##
+  ## The available options are:
+  ##
+  ## | name                 | Description
+  ## | -------------------- | -----------
+  ## | __sources__          | __Required__. This tells Double doc where to look for the source of the documentation. Can be either a string or an array of strings.
+  ## | __md_destination__   | __Required__. This is the directory where you want the generated markdown files to go.
+  ## | __html_destination__ | If you want a pretty HTML version of your documentation, all you have to do is to say where you want it.
+  ## | __html_template__    | You can use your own custom ERB template for HTML rendering. Have a look in the one we ship with DoubleDoc for inspiration (templates/default.html.erb).
+  ## | __html_renderer__    | If you want full control of the HTML rendering you can use your own implementation. Defaults to `DoubleDoc::HtmlRenderer`.
+  ## | __html_css__         | You can use your own custom CSS document by specifying it's path here.
+  ## | __title__            | The title you want in the generated HTML. Defaults to "Documentation".
+  ##
+  ## If you just want to use double doc to generate your readme.md for github, you should write your documentation in doc/readme.md and put his in your Rakefile:
+  ##
+  ## ```ruby
+  ## require 'double_doc'
+  ##
+  ## DoubleDoc::Task.new(:doc, :sources => 'doc/readme.md', :md_destination => '.')
+  ## ```
+  ## Then all you have to do is to run `rake doc`, and you will have a `readme.md` in the root of your project.
+  ##
+  ## You can even run `rake doc:publish` to generate html documentation and push it to your Github Pages.
   class Task
     include Rake::DSL if defined?(Rake::DSL)
 
@@ -12,14 +48,15 @@ module DoubleDoc
       md_dst   = Pathname.new(options[:md_destination])
       html_dst = Pathname.new(options[:html_destination]) if options[:html_destination]
       sources  = FileList[*options[:sources]]
-      import_handler = DoubleDoc::ImportHandler.new(options[:root] || Rake.original_dir)
 
       destinations = [md_dst, html_dst].compact
       destinations.each do |dst|
         directory(dst.to_s)
       end
 
-      task(task_name => destinations) do
+      desc "Generate markdown #{html_dst ? 'and HTML ' : ''}DoubleDoc documentation from #{sources.join(', ')}"
+      generate_task = task(task_name => destinations) do |t, args|
+        import_handler = DoubleDoc::ImportHandler.new(options[:root] || Rake.original_dir)
 
         sources.each do |src|
           dst = md_dst + File.basename(src)
@@ -29,12 +66,60 @@ module DoubleDoc
           end
         end
 
-        if html_dst
-          html_generator = DoubleDoc::HtmlGenerator.new(FileList[(md_dst + '*.md').to_s].sort, options)
+        if html_dst || args[:html_destination]
+          html_generator = DoubleDoc::HtmlGenerator.new(FileList[(md_dst + '*.md').to_s].sort, options.merge(args))
           html_generator.generate
         end
 
       end
+
+      namespace(task_name) do
+
+        desc "Publish DoubleDoc documentation to Github Pages"
+        task :publish do
+          git_clean = `git status -s`.empty? rescue false
+          raise "Your local git repository needs to be clean for this task to run" unless git_clean
+
+          git_branch = `git branch | grep "*"`.match(/\* (.*)/)[1] rescue 'master'
+
+          Dir.mktmpdir do |dir|
+            generate_task.execute(:html_destination => dir)
+            html_files = Dir.glob(Pathname.new(dir) + '*.html')
+
+            `git add .`
+            `git commit -m 'Updated documentation'`
+
+            has_github_pages = !`git branch | grep 'gh-pages'`.empty? rescue false
+
+            unless has_github_pages
+              puts "Setting up gh-pages branch"
+
+              `git symbolic-ref HEAD refs/heads/gh-pages`
+              `rm .git/index`
+              `git clean -fdx`
+            else
+              `git checkout gh-pages`
+              `git pull origin gh-pages`
+            end
+
+            puts "Publishing your Github Pages"
+            `cp #{dir}/* .`
+            if html_files.size == 1
+              `cp #{html_files[0]} index.html`
+            else
+              warn("You should probably generate an index.html")
+            end
+
+            `git add .`
+            `git commit -m 'Updated Github Pages'`
+            `git push origin gh-pages`
+            `git co #{git_branch}`
+
+            puts "Your Github Pages has been published. You will receive an email from Github when they are online."
+          end
+        end
+
+      end
     end
 
   end

data/lib/double_doc/version.rb

@@ -1,4 +1,4 @@
 ## ## DoubleDoc 1.0
 module DoubleDoc
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/double_doc.rb

@@ -1,5 +1,2 @@
 require "double_doc/version"
-
-module Guard
-  autoload :Doubledoc, 'double_doc/guard'
-end
+require "double_doc/task"

data/lib/{double_doc/guard.rb → guard/double_doc.rb}

@@ -3,7 +3,7 @@ require 'guard/guard'
 require 'rake'
 
 module Guard
-  class Doubledoc < Guard
+  class DoubleDoc < Guard
     include ::Rake::DSL
 
     def start
@@ -27,7 +27,7 @@ module Guard
     def run_rake_task
       UI.info "generating double docs"
       ::Rake::Task.tasks.each { |t| t.reenable }
-      ::Rake::Task[@options[:task]].invoke
+      ::Rake::Task[@options[:rake_task]].invoke
     end
   end
 end

data/lib/guard/doubledoc.rb

@@ -0,0 +1,4 @@
+require 'guard/double_doc'
+
+class Guard::Doubledoc < Guard::DoubleDoc
+end

data/templates/default.html.erb

@@ -5,10 +5,6 @@
     <meta name="apple-mobile-web-app-capable" content="yes">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title><%= title %></title>
-    <link href="http://fonts.googleapis.com/css?family=Droid+Sans+Mono" rel="stylesheet" type="text/css">
-    <style type="text/css">
-      <%= highlight_css %>
-    </style>
     <link rel="stylesheet" href="<%= css %>">
   </head>
   <body>

data/templates/screen.css

@@ -250,12 +250,19 @@ a {
 
 #content table {
   margin-bottom: 1.625em;
+  padding-bottom: 0.5em;
   border-collapse: collapse;
+  border-spacing: 0;
   font-size: 80%;
+  display: block;
+  border: 1px solid #DDD;
+  border-radius: 6px;
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
 }
 
 #content th {
   font-weight: bold;
+  white-space: nowrap;
 }
 
 #content tr, #content th, #content td {
@@ -264,6 +271,15 @@ a {
   height: 26px;
 }
 
+#content table tbody tr:nth-child(odd) {
+  background-color: #F8F8F8;
+}
+
+#content table thead tr {
+  border-bottom: 1px solid #DADADA;
+  line-height: 240%;
+}
+
 #content tfoot {
   font-style: italic;
 }
@@ -324,23 +340,18 @@ a {
 }
 
 #content pre, #content code, #content tt {
-  font: .7em "Droid Sans Mono", Monaco, monospace;
+  font: 12px "Bitstream Vera Sans Mono", "Courier", monospace;
   line-height: 1.5;
 }
 
 #content pre {
-  background: #f8f8ff;
+  background: #F8F8F8;
   padding: 10px;
   border: 1px solid #ddd;
   border-radius: 6px;
   word-wrap: break-word;
 }
 
-.highlight {
-  background: none;
-}
-
-
 #content tt {
   display: block;
   margin: 1.625em 0;
@@ -366,4 +377,68 @@ a {
     padding: 30px;
     position: relative;
   }
-}
+}
+
+/* This was generated like this: `pygmentize -S github -f html -a .highlight` */
+.highlight .hll { background-color: #ffffcc }
+.highlight  { background: #ffffff; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { color: #000000; font-weight: bold } /* Keyword */
+.highlight .o { color: #000000; font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d01040 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nl { color: #990000; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d01040 } /* Literal.String.Backtick */
+.highlight .sc { color: #d01040 } /* Literal.String.Char */
+.highlight .sd { color: #d01040 } /* Literal.String.Doc */
+.highlight .s2 { color: #d01040 } /* Literal.String.Double */
+.highlight .se { color: #d01040 } /* Literal.String.Escape */
+.highlight .sh { color: #d01040 } /* Literal.String.Heredoc */
+.highlight .si { color: #d01040 } /* Literal.String.Interpol */
+.highlight .sx { color: #d01040 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d01040 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

data/test/doc_extractor_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe "the doc extractor" do
+  describe "on ruby files" do
+    ## this line should be extracted
+    # this line should not be extracted
+    ## this line should also be extracted
+
+    before do
+      @doc = DoubleDoc::DocExtractor.extract(File.new(__FILE__))
+    end
+
+    it "should extract documentation from ruby files" do
+      @doc.must_match(/this line should be extracted/)
+      @doc.must_match(/this line should also be extracted/)
+    end
+
+    it "should not extract regular comments" do
+      @doc.wont_match(/this line should not be extracted/)
+    end
+
+    it "should not add any extra new-lines" do
+      @doc.must_match(/^this/m)
+      @doc.must_match(/extracted\n$/m)
+    end
+
+    it "add an empty line between documentation sections" do
+      @doc.must_match(/extracted\n\nthis/m)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler"
+Bundler.require
+
+require "minitest/autorun"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: double_doc
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-18 00:00:00.000000000 Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70226292443260 !ruby/object:Gem::Requirement
+  requirement: &70134689089720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226292443260
+  version_requirements: *70134689089720
 - !ruby/object:Gem::Dependency
-  name: guard-rake
-  requirement: &70226292442540 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: &70134689089300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226292442540
+  version_requirements: *70134689089300
 - !ruby/object:Gem::Dependency
-  name: erubis
-  requirement: &70226292441960 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70134689088880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70226292441960
+  version_requirements: *70134689088880
 - !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: &70226292441220 !ruby/object:Gem::Requirement
+  name: erubis
+  requirement: &70134689088460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,18 +54,29 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70226292441220
+  version_requirements: *70134689088460
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70134689087960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70134689087960
 - !ruby/object:Gem::Dependency
   name: pygments.rb
-  requirement: &70226292440440 !ruby/object:Gem::Requirement
+  requirement: &70134689087460 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70226292440440
+  version_requirements: *70134689087460
 description: A simple framework for writing and generating beautiful documentation
   for your code
 email:
@@ -74,25 +85,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- Guardfile
-- Rakefile
-- doc/license.md
-- doc/readme.md
-- doc/todo.md
-- double_doc.gemspec
-- lib/double_doc.rb
 - lib/double_doc/doc_extractor.rb
-- lib/double_doc/guard.rb
 - lib/double_doc/html_generator.rb
 - lib/double_doc/html_renderer.rb
 - lib/double_doc/import_handler.rb
 - lib/double_doc/task.rb
 - lib/double_doc/version.rb
-- readme.md
+- lib/double_doc.rb
+- lib/guard/double_doc.rb
+- lib/guard/doubledoc.rb
 - templates/default.html.erb
 - templates/screen.css
+- README.md
+- test/doc_extractor_test.rb
+- test/test_helper.rb
 homepage: http://staugaard.github.com/double_doc
 licenses: []
 post_install_message: 
@@ -112,9 +118,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: double_doc
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Documentation right where you want it
-test_files: []
+test_files:
+- test/doc_extractor_test.rb
+- test/test_helper.rb

data/.gitignore

@@ -1,5 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-site

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in double_doc.gemspec
-gemspec

data/Guardfile

@@ -1,6 +0,0 @@
-$LOAD_PATH.unshift 'lib'
-require 'double_doc'
-
-guard :double_doc, :task => 'doc' do
-  watch(%r{^(doc|lib|templates)/})
-end

data/Rakefile

@@ -1,29 +0,0 @@
-require "bundler/gem_tasks"
-
-$LOAD_PATH.unshift 'lib'
-
-require 'double_doc/task'
-
-desc "Generate documentation"
-DoubleDoc::Task.new(:doc,
-  :sources => 'doc/readme.md',
-  :md_destination => '.',
-  :html_destination => 'site',
-  :title => 'API Documentaion'
-)
-
-desc "Publish docs to github"
-task :publish => :doc do
-  `git add doc`
-  `git add readme.md`
-  `git commit -m 'Updated documentation'`
-  `git push origin master`
-  `git checkout gh-pages`
-  `cp site/* .`
-  `cp readme.html index.html`
-  `git commit -a -m 'Updated site'`
-  `git push origin gh-pages`
-  `git co master`
-end
-
-task :default => [:doc]

data/doc/license.md

@@ -1,9 +0,0 @@
-#### The MIT License
-
-Copyright © 2012 [Mick Staugaard](mailto:mick@staugaard.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS,” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/doc/readme.md

@@ -1,72 +0,0 @@
-@import lib/double_doc/version.rb
-
-One of the challenges you face when writing public documention for code or APIs, is that you have to remember to update the documentation
-when ever you change the API. The main reason why this is a problem is that very often the documentation lives very for from your code.
-
-This is the problem DoubleDoc tries to solve.
-
-DoubleDoc allows you to write the documentation right where your code is, and you can combine it all into a well structured document.
-
-### Format
-You write your documentation in markdown right in your source code files by double commenting it:
-
-```ruby
-class User < ActiveRecord::Base
-
-  ## ```js
-  ## {
-  ##   "id":   1,
-  ##   "name": "Mick Staugaard"
-  ## }
-  ## ```
-  def as_json
-    # this comment will not be included in the documentation
-    # as it only has a single # character
-    super(:only => [:id, :name])
-  end
-
-end
-
-class UsersController < ApplicationController
-  ## ### Getting a User
-  ## `GET /users/{id}.json`
-  ##
-  ## #### Format
-  ## @@import app/models/user.rb
-  def show
-    render :json => User.find(params[:id])
-  end
-end
-```
-
-You would then write a markdown document about your User API:
-
-    ## Users
-    You can acces users in our system by using our REST API, blah blah blah...
-    
-    @@import app/controllers/users_controller.rb
-
-And DoubleDoc will generate this markdown document for you:
-
-    ## Users
-    You can acces users in our system by using our REST API, blah blah blah...
-    
-    ### Getting a User
-    `GET /users/{id}.json`
-    
-    #### Format
-    ```js
-    {
-      "id":   1,
-      "name": "Mick Staugaard"
-    }
-    ```
-
-### Rake Task
-@import lib/double_doc/task.rb
-
-### TODO
-@import doc/todo.md
-
-### License
-@import doc/license.md

data/doc/todo.md

@@ -1,4 +0,0 @@
-* Tests
-* Support for directory structures
-* Documentation for the Rake task
-* Documentation for the Guard

data/double_doc.gemspec

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "double_doc/version"
-
-Gem::Specification.new do |s|
-  s.name        = "double_doc"
-  s.version     = DoubleDoc::VERSION
-  s.authors     = ["Mick Staugaard"]
-  s.email       = ["mick@staugaard.com"]
-  s.homepage    = "http://staugaard.github.com/double_doc"
-  s.summary     = "Documentation right where you want it"
-  s.description = "A simple framework for writing and generating beautiful documentation for your code"
-
-  s.rubyforge_project = "double_doc"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rake"
-
-  s.add_runtime_dependency "erubis"
-  s.add_runtime_dependency "redcarpet"
-  s.add_runtime_dependency "pygments.rb"
-end