double_doc 1.0.5 → 1.0.6

data/README.md

@@ -90,16 +90,16 @@ The available options are:
 | __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:
+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 => '.')
+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.
+If you have a gh-pages branch set up in your repository, you can event 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.

data/lib/double_doc/html_generator.rb

@@ -64,7 +64,7 @@ module DoubleDoc
     end
 
     def copy_assets
-      if @html_renderer == HtmlRenderer
+      if @stylesheet == 'screen.css'
         FileUtils.cp(File.expand_path("../../templates/screen.css", File.dirname(__FILE__)), @output_directory)
       end
     end
@@ -100,4 +100,4 @@ module DoubleDoc
     end
   end
 
-end
+end

data/lib/double_doc/task.rb

@@ -31,16 +31,16 @@ module DoubleDoc
   ## | __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:
+  ## 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 => '.')
+  ## 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.
+  ## If you have a gh-pages branch set up in your repository, you can event run `rake doc:publish` to generate html documentation and push it to your github pages.
   class Task
     include Rake::DSL if defined?(Rake::DSL)
 
@@ -73,52 +73,38 @@ module DoubleDoc
 
       end
 
-      namespace(task_name) do
+      has_github_pages = !`git branch | grep 'gh-pages'`.empty? rescue false
 
-        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
+      if has_github_pages
+        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'
+            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')
+            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 add .`
+              `git commit -m 'Updated documentation'`
               `git checkout gh-pages`
               `git pull origin gh-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}`
             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
 

data/lib/double_doc/version.rb

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

metadata

@@ -1,90 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: double_doc
-version: !ruby/object:Gem::Version
-  version: 1.0.5
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 6
+  version: 1.0.6
 platform: ruby
-authors:
+authors: 
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: &70134689089720 !ruby/object:Gem::Requirement
+
+date: 2012-02-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id001
   type: :development
+  name: guard
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70134689089720
-- !ruby/object:Gem::Dependency
+  requirement: *id002
+  type: :development
   name: minitest
-  requirement: &70134689089300 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70134689089300
-- !ruby/object:Gem::Dependency
+  requirement: *id003
+  type: :runtime
   name: rake
-  requirement: &70134689088880 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70134689088880
-- !ruby/object:Gem::Dependency
+  requirement: *id004
+  type: :runtime
   name: erubis
-  requirement: &70134689088460 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
   prerelease: false
-  version_requirements: *70134689088460
-- !ruby/object:Gem::Dependency
+  requirement: *id005
+  type: :runtime
   name: redcarpet
-  requirement: &70134689087960 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
   prerelease: false
-  version_requirements: *70134689087960
-- !ruby/object:Gem::Dependency
-  name: pygments.rb
-  requirement: &70134689087460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.2'
+  requirement: *id006
   type: :runtime
-  prerelease: false
-  version_requirements: *70134689087460
-description: A simple framework for writing and generating beautiful documentation
-  for your code
-email:
+  name: pygments.rb
+description: A simple framework for writing and generating beautiful documentation for your code
+email: 
 - mick@staugaard.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/double_doc/doc_extractor.rb
 - lib/double_doc/html_generator.rb
 - lib/double_doc/html_renderer.rb
@@ -101,28 +129,37 @@ files:
 - test/test_helper.rb
 homepage: http://staugaard.github.com/double_doc
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.15
 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