diff options
| author | Julie | 2014-02-19 11:53:02 -0800 | 
|---|---|---|
| committer | Peter Bacon Darwin | 2014-02-21 09:59:12 +0000 | 
| commit | 4d7e1cef370586c6644e226c55db1fcd234346ad (patch) | |
| tree | 08e42fc57248439da95a07cb56091c09fd5268f1 | |
| parent | 58b01fac1ec80b34f2deb2fe87321a9de19ea6d7 (diff) | |
| download | angular.js-4d7e1cef370586c6644e226c55db1fcd234346ad.tar.bz2 | |
chore(doc-gen): generate examples for each deployment, e.g. jquery
Update to the latest dgeni-packages, which supports multiple
deployment environments for the examples.
Add a jQuery deployment environment for the examples.
Currently, the target of the runnable example iframe always points
to the default deployment environment, not to the environment under
which the main app is running.
Closes #6361
| -rw-r--r-- | docs/config/index.js | 6 | ||||
| -rw-r--r-- | docs/config/processors/index-page.js | 4 | ||||
| -rw-r--r-- | docs/docs.config.js | 64 | ||||
| -rw-r--r-- | package.json | 2 | 
4 files changed, 64 insertions, 12 deletions
| diff --git a/docs/config/index.js b/docs/config/index.js index ea15ce44..30ab22ee 100644 --- a/docs/config/index.js +++ b/docs/config/index.js @@ -2,11 +2,13 @@ var _ = require('lodash');  var path = require('canonical-path');  var packagePath = __dirname; -var angularjsPackage = require('dgeni-packages/ngdoc'); +var basePackage = require('dgeni-packages/ngdoc'); +var examplesPackage = require('dgeni-packages/examples');  module.exports = function(config) { -  config = angularjsPackage(config); +  config = basePackage(config); +  config = examplesPackage(config);    config.append('processing.processors', [      require('./processors/git-data'), diff --git a/docs/config/processors/index-page.js b/docs/config/processors/index-page.js index 3ba1ac73..37a274ec 100644 --- a/docs/config/processors/index-page.js +++ b/docs/config/processors/index-page.js @@ -11,7 +11,7 @@ module.exports = {    init: function(config) {      deployment = config.deployment;      if ( !deployment || !deployment.environments ) { -      throw new Errro('No deployment environments found in the config.'); +      throw new Error('No deployment environments found in the config.');      }    },    process: function(docs) { @@ -39,4 +39,4 @@ module.exports = {        docs.push(indexDoc);      });    } -};
\ No newline at end of file +}; diff --git a/docs/docs.config.js b/docs/docs.config.js index afe982fd..c1539cb6 100644 --- a/docs/docs.config.js +++ b/docs/docs.config.js @@ -25,13 +25,6 @@ module.exports = function(config) {      { pattern: '**/*.ngdoc', basePath: path.resolve(basePath, 'content') }    ]); -  config.set('processing.examples.commonFiles', { -    scripts: [ '../../../angular.js' ], -    stylesheets: [] -  }); -  config.set('processing.examples.dependencyPath', '../../..'); - -    config.set('processing.errors.minerrInfoPath', path.resolve(basePath, '../build/errors.json'));    config.set('rendering.outputFolder', '../build/docs'); @@ -41,6 +34,12 @@ module.exports = function(config) {    config.merge('deployment', {      environments: [{        name: 'debug', +      examples: { +        commonFiles: { +          scripts: [ '../../../angular.js' ] +        }, +        dependencyPath: '../../..' +      },        scripts: [          '../angular.js',          '../angular-resource.js', @@ -70,7 +69,52 @@ module.exports = function(config) {      },      {        name: 'default', +      examples: { +        commonFiles: { +          scripts: [ '../../../angular.min.js' ] +        }, +        dependencyPath: '../../..' +      }, +      scripts: [ +        '../angular.min.js', +        '../angular-resource.min.js', +        '../angular-route.min.js', +        '../angular-cookies.min.js', +        '../angular-sanitize.min.js', +        '../angular-touch.min.js', +        '../angular-animate.min.js', +        'components/marked-' + getVersion('marked', '../node_modules', 'package.json') + '/lib/marked.js', +        'js/angular-bootstrap/bootstrap.js', +        'js/angular-bootstrap/bootstrap-prettify.js', +        'js/angular-bootstrap/dropdown-toggle.js', +        'components/lunr.js-' + getVersion('lunr.js') + '/lunr.min.js', +        'components/google-code-prettify-' + getVersion('google-code-prettify') + '/src/prettify.js', +        'components/google-code-prettify-' + getVersion('google-code-prettify') + '/src/lang-css.js', +        'js/versions-data.js', +        'js/pages-data.js', +        'js/docs.js' +      ], +      stylesheets: [ +        'components/bootstrap-' + getVersion('bootstrap') + '/dist/css/bootstrap.min.css', +        'components/open-sans-fontface-' + getVersion('open-sans-fontface') + '/open-sans.css', +        'css/prettify-theme.css', +        'css/docs.css', +        'css/animations.css' +      ] +    }, +    { +      name: 'jquery', +      examples: { +        commonFiles: { +          scripts: [ +            '../../components/jquery-' + getVersion('jquery') + '/jquery.js', +            '../../../angular.js' +          ] +        }, +        dependencyPath: '../../..' +      },        scripts: [ +        'components/jquery-' + getVersion('jquery') + '/jquery.js',          '../angular.min.js',          '../angular-resource.min.js',          '../angular-route.min.js', @@ -99,6 +143,12 @@ module.exports = function(config) {      },      {        name: 'production', +      examples: { +        commonFiles: { +          scripts: [ cdnUrl + '/angular.min.js' ] +        }, +        dependencyPath: cdnUrl +      },        scripts: [          cdnUrl + '/angular.min.js',          cdnUrl + '/angular-resource.min.js', diff --git a/package.json b/package.json index 80006e9c..a36fb83f 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@      "canonical-path": "0.0.2",      "winston": "~0.7.2",      "dgeni": "~0.1.0", -    "dgeni-packages": "~0.1.0", +    "dgeni-packages": "^0.2.2",      "gulp-jshint": "~1.4.2",      "jshint-stylish": "~0.1.5"    }, | 
