Skip to content
This repository has been archived by the owner on Nov 11, 2017. It is now read-only.

Commit

Permalink
Initial attempt at documentation. Should be extended to methods as well
Browse files Browse the repository at this point in the history
  • Loading branch information
mscharley committed Dec 13, 2013
1 parent 41404d5 commit 2434cb5
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .cane
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
--color
--max-violations 3
--max-violations 0
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
*.gem
.yardoc
/doc
9 changes: 7 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,17 @@ end

desc "Cleans unneeded or old files"
task :clean do
Dir['*.gem'].each do |f|
rm f
Dir['{*.gem,doc}'].each do |f|
rm_rf f
end
end

desc "Install locally"
task :install => [:clean, :build] do
sh 'gem', 'install', *Dir['*.gem']
end

desc "Create the documentation for the project"
task :doc do
sh 'yard'
end
2 changes: 2 additions & 0 deletions lib/jekyll/compass/compass_file.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

module Jekyll
module Compass
# This seemed to be necessary at the time, however I'm not sure now if it
# is or not. (very) minor performance boost.
class CompassFile < StaticFile
def write(destination)
# Short-circuit to the inevitable
Expand Down
4 changes: 4 additions & 0 deletions lib/jekyll/compass/generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

module Jekyll
module Compass
# This is the main generator plugin for Jekyll. Jekyll finds these plugins
# itself, we just need to be setup by the user as a gem plugin for their
# website. The plugin will only do something if there is a `_sass` folder
# in the source folder of the Jekyll website.
class Generator < ::Jekyll::Generator
safe true
priority :high
Expand Down

0 comments on commit 2434cb5

Please sign in to comment.