Merge branch 'master' into doc-tags (7d83dcb1) · Commits · extjs / jsduck

README.md

+6 −32

Original line number	Diff line number	Diff line
		@@ -34,38 +34,12 @@ Standard rubygems install should do:

		$ [sudo] gem install jsduck

		If you encounter errors during gem installation, you may need to
		install the header files for compiling extension modules for Ruby 1.9.
		For Debian systems you'll need the `ruby1.9-dev` package. For Red Hat
		/ CentOS / Fedora use the `ruby-devel` package.

		In OSX Mountain Lion the compilation of `therubyracer` dependency
		often fails for so far unknown reasons. Most users have found a
		solution in upgrading to Ruby 1.9 using [RVM][].

		For Windows users out there, you can download the binary version,
		which includes Ruby interpreter and all dependencies bundled in a
		single .exe file. Grab it from the [download page][].

		Alternatively you can install through rubygems, but you need to do
		some additional tweaks. First go and [download][libs download]
		therubyracer gem and v8 lib that stereobooster has built for
		windows. You need to install this special rubyracer version instead of
		the one from rubygems:

		> gem install therubyracer-0.11.0beta1-x86-mingw32.gem

		To make it actually work you need `v8.dll` somewhere in your
		system. Extract the `lib_v8.3.11.9.zip` take the `v8.dll` inside it
		and place into the `bin` directory of your Ruby installation (other
		dirs that are on your PATH can work too, but I've found this to be the
		most sensible place to put it). Now you're ready to install JSDuck:

		> gem install jsduck

		[RVM]: https://rvm.io/
		[download page]: https://sourceforge.net/projects/jsduck/files/
		[libs download]: https://github.com/stereobooster/therubyracer/downloads
		Windows users probably want to [download a binary release][winbin].

		See the [installation guide][] for help when you run into problems.

		[winbin]: https://sourceforge.net/projects/jsduck/files/
		[installation guide]: https://github.com/senchalabs/jsduck/wiki/Installation

		Usage
		-----

lib/jsduck/options.rb

+19 −0

Original line number	Diff line number	Diff line
		@@ -24,6 +24,7 @@ module JsDuck
		attr_accessor :footer
		attr_accessor :head_html
		attr_accessor :body_html
		attr_accessor :message
		attr_accessor :welcome
		attr_accessor :guides
		attr_accessor :videos
		@@ -98,6 +99,7 @@ module JsDuck
		@footer = "Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> #{@version}."
		@head_html = ""
		@body_html = ""
		@message = ""
		@welcome = nil
		@guides = nil
		@videos = nil
		@@ -292,6 +294,15 @@ module JsDuck
		@body_html += html
		end

		opts.on('--message=HTML',
		"(Warning) message to show prominently.",
		"",
		"Useful for warning users that they are viewing an old",
		"version of the docs, and prividing a link to the new",
		"version.") do \|html\|
		@message += html
		end

		opts.on('--welcome=PATH',
		"File with content for welcome page.",
		"",
		@@ -628,6 +639,14 @@ module JsDuck
		@template_links = true
		end

		opts.on('-d', '--debug',
		"Same as --template=template --template-links.",
		"",
		"Useful shorthand during development.") do
		@template_dir = canonical("template")
		@template_links = true
		end

		opts.on('--extjs-path=PATH',
		"Path for main ExtJS JavaScript file.",
		"",

lib/jsduck/web/data.rb

+1 −0

Original line number	Diff line number	Diff line
		@@ -35,6 +35,7 @@ module JsDuck
		:source => @opts.source,
		:commentsUrl => @opts.comments_url,
		:commentsDomain => @opts.comments_domain,
		:message => @opts.message,
		}
		}) + ";\n"

template/app/view/cls/Index.js

+1 −1

Original line number	Diff line number	Diff line
		@@ -22,7 +22,7 @@ Ext.define('Docs.view.cls.Index', {
		'{categories}'
		);
		this.data = {
		notice: Docs.ContentGrabber.get("notice-text"),
		notice: Docs.data.message \|\| Docs.ContentGrabber.get("notice-text"),
		categories: Docs.ContentGrabber.get("categories-content")
		};