Commit eeb476fe authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Merge remote-tracking branch 'origin/master'

parents 84cc4429 54372dfb

.travis.yml

0 → 100644
+11 −0
Original line number Diff line number Diff line 
language: ruby

rvm:

  - "1.8.7"

  - "1.9.2"

install:

  - gem install rdiscount

  - gem install json

  - gem install parallel

  - gem install therubyracer

  - gem install rspec

  - gem install rake

README.md

+2 −0
Original line number Diff line number Diff line 
JSDuck

======



[![Build Status](https://travis-ci.org/senchalabs/jsduck.png)](https://travis-ci.org/senchalabs/jsduck)



API documentation generator for Sencha JavaScript frameworks.



JSDuck aims to be a better documentation generator for [Ext JS][] than

Rakefile

+31 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ def load_sdk_vars 
    puts "    OUT_DIR='/path/to/ouput/dir'"

    puts "    # path to Ext JS 4 build"

    puts "    EXT_BUILD='/path/to/ext-4'"

    puts "    # path to Touch 2 build"

    puts "    # path to Touch 2 build (for building Sencha Touch)"

    puts "    TOUCH_BUILD='/path/to/touch-2'"

    puts "    # path to SDK (for developers at Sencha)"

    puts "    SDK_DIR='/path/to/SDK'"
@@ -206,6 +206,36 @@ class JsDuckRunner 
  end

end



# Download ExtJS into template/extjs

task :get_extjs do

  system "curl -o template/extjs.zip http://cdn.sencha.com/ext-4.1.1a-gpl.zip"

  system "unzip template/extjs.zip -d template/"

  system "rm -rf template/extjs"

  system "mv template/ext-4.1.1a template/extjs"

  system "rm template/extjs.zip"

end



# Auto-generate sdk-vars.rb config file

task :config_file do

  if File.exists?("sdk-vars.rb")

    puts "sdk-vars.rb already exists. Keeping it."

  else

    puts "Generating sdk-vars.rb with the following content:"

    config = <<-EORUBY

# where to output the docs

OUT_DIR='#{Dir.pwd}/output'

# path to Ext JS 4 build

EXT_BUILD='#{Dir.pwd}/template/extjs'

    EORUBY

    puts

    puts config

    File.open("sdk-vars.rb", "w") {|h| h.write(config) }

  end

end



desc "Download ExtJS and initialize sdk-vars.rb config file"

task :configure => [:get_extjs, :config_file]



# Run compass to generate CSS files

task :sass do

  system "compass compile --quiet template/resources/sass"

lib/jsduck/options.rb

+1 −1
Original line number Diff line number Diff line
@@ -347,7 +347,7 @@ module JsDuck 
          "",

          "    --import='1.0:/path/to/first/version'",

          "    --import='2.0:/path/to/second/version'",

          "    --import='3.0",

          "    --import='3.0'",

          "",

          "Several versions can be imported using the option multiple",

          "times.  The last version must always be the current one",

template/print-template.html

+3 −1
Original line number Diff line number Diff line
@@ -28,7 +28,9 @@ 
  </div>

  <div id="center-container" class="class-overview" style="padding: 20px">

    <div class="x-panel-body">

      <article>

        {body}

      </article>

    </div>

  </div>