From 37082cf78309284acb0458152e6e4609fbf9f4cf Mon Sep 17 00:00:00 2001 From: Ibby Date: Mon, 13 Mar 2017 14:42:33 -0400 Subject: [PATCH] chore(docs): remove gitPackage from doc generator --- scripts/docs/dgeni-config.js | 6 ++---- scripts/docs/dgeni-readmes-config.js | 6 ++---- scripts/docs/templates/common.template.html | 2 +- scripts/docs/typescript-definition-package/index.js | 12 ++++++------ .../templates/type-definition.template.html | 1 - 5 files changed, 11 insertions(+), 16 deletions(-) diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index de4ed1c10..ef2ce6a65 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -3,7 +3,6 @@ var jsdocPackage = require('dgeni-packages/jsdoc'); var nunjucksPackage = require('dgeni-packages/nunjucks'); var typescriptPackage = require('./typescript-package'); var linksPackage = require('./links-package'); -var gitPackage = require('dgeni-packages/git'); var path = require('path'); var semver = require('semver'); var fs = require('fs'); @@ -16,7 +15,7 @@ module.exports = function(currentVersion) { return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, - linksPackage, gitPackage]) + linksPackage]) // .processor(require('./processors/latest-version')) .processor(require('./processors/jekyll')) @@ -72,7 +71,7 @@ module.exports = function(currentVersion) { log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error' }) -.config(function(renderDocsProcessor, computePathsProcessor, versionInfo) { +.config(function(renderDocsProcessor, computePathsProcessor) { versions = []; // new version, add it to the versions list @@ -98,7 +97,6 @@ module.exports = function(currentVersion) { }; renderDocsProcessor.extraData.version = versionData; - renderDocsProcessor.extraData.versionInfo = versionInfo; computePathsProcessor.pathTemplates = [{ docTypes: ['class', 'var', 'function', 'let'], getOutputPath: function(doc) { diff --git a/scripts/docs/dgeni-readmes-config.js b/scripts/docs/dgeni-readmes-config.js index a894f5ad5..80cf68714 100644 --- a/scripts/docs/dgeni-readmes-config.js +++ b/scripts/docs/dgeni-readmes-config.js @@ -3,7 +3,6 @@ var jsdocPackage = require('dgeni-packages/jsdoc'); var nunjucksPackage = require('dgeni-packages/nunjucks'); var typescriptPackage = require('./typescript-package'); var linksPackage = require('./links-package'); -var gitPackage = require('dgeni-packages/git'); var path = require('path'); var semver = require('semver'); var fs = require('fs'); @@ -18,7 +17,7 @@ module.exports = function(currentVersion) { return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, - linksPackage, gitPackage]) + linksPackage]) // .processor(require('./processors/latest-version')) .processor(require('./processors/readmes')) @@ -73,7 +72,7 @@ module.exports = function(currentVersion) { log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error' }) -.config(function(renderDocsProcessor, computePathsProcessor, versionInfo) { +.config(function(renderDocsProcessor, computePathsProcessor) { versions = []; // new version, add it to the versions list @@ -99,7 +98,6 @@ module.exports = function(currentVersion) { }; renderDocsProcessor.extraData.version = versionData; - renderDocsProcessor.extraData.versionInfo = versionInfo; computePathsProcessor.pathTemplates = [{ docTypes: ['class', 'var', 'function', 'let'], getOutputPath: function(doc) { diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 2f0de86ce..5143e535f 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -53,7 +53,7 @@ docType: "<$ doc.docType $>" <@- endmacro -@> <@ macro githubViewLink(doc) -@> -<$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>) +<$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>) <@- endmacro -@> <@ macro paramTable(params, isDirective) -@> diff --git a/scripts/docs/typescript-definition-package/index.js b/scripts/docs/typescript-definition-package/index.js index 532cfe5d3..ce77a83c9 100644 --- a/scripts/docs/typescript-definition-package/index.js +++ b/scripts/docs/typescript-definition-package/index.js @@ -25,9 +25,9 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, }) -.config(function(renderDocsProcessor, versionInfo) { - renderDocsProcessor.extraData.versionInfo = versionInfo; -}) +// .config(function(renderDocsProcessor, versionInfo) { +// renderDocsProcessor.extraData.versionInfo = versionInfo; +// }) .config(function(readFilesProcessor, inlineTagProcessor, readTypeScriptModules, createTypeDefinitionFile) { @@ -42,7 +42,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, 'angular2/router.ts' ]; readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../modules')); - + createTypeDefinitionFile.typeDefinitions = [ { id: 'angular2/angular2', @@ -55,7 +55,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, modules: { 'angular2/router': 'angular2/router' } - } + } ]; }) @@ -97,4 +97,4 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, '${ doc.docType }.template.html', 'common.template.html' ]; -}); \ No newline at end of file +}); diff --git a/scripts/docs/typescript-definition-package/templates/type-definition.template.html b/scripts/docs/typescript-definition-package/templates/type-definition.template.html index 4ebceffaa..d37344087 100644 --- a/scripts/docs/typescript-definition-package/templates/type-definition.template.html +++ b/scripts/docs/typescript-definition-package/templates/type-definition.template.html @@ -18,7 +18,6 @@ {%- endmacro -%} -// Type definitions for Angular v{$ versionInfo.currentVersion.full | replace(r/\+/, "_") $} // Project: http://angular.io/ // Definitions by: angular team // Definitions: https://github.com/borisyankov/DefinitelyTyped