Skip to content

Commit

Permalink
Switch to YUIDoc for API docs.
Browse files Browse the repository at this point in the history
Squashed commit of the following:

commit f6e539f
Author: Jeremy Kahn <jeremyckahn@gmail.com>
Date:   Tue Nov 11 20:51:06 2014 -0600

    Package up 1.3.6.

commit b4b63fb
Merge: 525c765 b0ed17b
Author: Jeremy Kahn <jeremyckahn@gmail.com>
Date:   Tue Nov 11 20:33:17 2014 -0600

    Merge branch 'master' into feature/yuidoc

commit 525c765
Author: Jeremy Kahn <jeremyckahn@gmail.com>
Date:   Sun Nov 9 10:59:17 2014 -0600

    Improve token docs.

commit 6d10470
Author: Jeremy Kahn <jeremyckahn@gmail.com>
Date:   Sun Nov 9 10:36:11 2014 -0600

    Reconfigure how docs are generated.

commit 5ade61b
Author: Jeremy Kahn <jeremyckahn@gmail.com>
Date:   Tue Nov 4 21:06:15 2014 -0600

    Wires up yuidoc and updates shifty.core.js annotations.
  • Loading branch information
jeremyckahn committed Nov 12, 2014
1 parent b0ed17b commit 01ea2a6
Show file tree
Hide file tree
Showing 44 changed files with 6,858 additions and 1,733 deletions.
48 changes: 30 additions & 18 deletions Gruntfile.js
Expand Up @@ -8,7 +8,8 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-bump');
grunt.loadNpmTasks('grunt-codepainter');
grunt.loadNpmTasks('grunt-dox');
grunt.loadNpmTasks('grunt-contrib-yuidoc');
grunt.loadNpmTasks('grunt-contrib-copy');

var banner = [
'/*! <%= pkg.name %> - v<%= pkg.version %> - ',
Expand Down Expand Up @@ -86,20 +87,6 @@ module.exports = function(grunt) {
dest: 'dist/shifty.js'
}
},
dox: {
options: {
title: 'Shifty'
},
files: {
src: [
'src/shifty.core.js',
'src/shifty.interpolate.js',
'src/shifty.bezier.js',
'src/shifty.token.js'
],
dest: 'dist/doc'
}
},
bump: {
options: {
files: ['package.json', 'bower.json'],
Expand All @@ -122,6 +109,30 @@ module.exports = function(grunt) {
dest: 'src/'
}]
}
},
yuidoc: {
compile: {
name: 'Shifty',
description: '<%= pkg.description %>',
version: '<%= pkg.version %>',
url: '<%= pkg.homepage %>',
logo: '../../asset/img/shifty-logo-200.png',
options: {
paths: ['dist'],
recurse: false,
outdir: 'dist/doc'
}
}
},
copy: {
redirects: {
files: [
{ src: ['redirects/src/shifty.bezier.js.html'], dest: 'dist/doc/src/shifty.bezier.js.html' },
{ src: ['redirects/src/shifty.core.js.html'], dest: 'dist/doc/src/shifty.core.js.html' },
{ src: ['redirects/src/shifty.interpolate.js.html'], dest: 'dist/doc/src/shifty.interpolate.js.html' },
{ src: ['redirects/src/shifty.token.js.html'], dest: 'dist/doc/src/shifty.token.js.html' },
]
}
}
});

Expand All @@ -134,14 +145,15 @@ module.exports = function(grunt) {
'concat:forRekapi',
'uglify:standardTarget',
'concat:forRekapiDebug',
'dox'
'yuidoc',
'copy:redirects'
]);

grunt.registerTask('build-minimal', [
'concat:minimal',
'uglify:standardTarget',
'concat:minimalDebug',
'dox'
'yuidoc',
'copy:redirects'
]);

};
Binary file added asset/img/shifty-logo-200.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion bower.json
@@ -1,6 +1,6 @@
{
"name": "shifty",
"version": "1.3.5",
"version": "1.3.6",
"main": "./dist/shifty.min.js",
"homepage": "http://jeremyckahn.github.io/shifty",
"description": "A teeny tiny tweening engine in JavaScript.",
Expand Down
23 changes: 23 additions & 0 deletions dist/doc/api.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added dist/doc/assets/css/external-small.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/doc/assets/css/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 01ea2a6

Please sign in to comment.