From 75187d605b5ac6ea6d4b3db7a6416100ff3505ed Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Tue, 6 Oct 2015 09:03:44 -0700 Subject: [PATCH] chore: remove unused docs/dgeni tasks and packages This stuff now lives in angular.io repo. Related to #4477 Closes #4552 --- docs/angular.io-package/index.js | 76 ---- docs/angular.io-package/mocks/mockPackage.js | 8 - .../processors/addJadeDataDocsProcessor.js | 86 ---- .../addJadeDataDocsProcessor.spec.js | 66 --- .../processors/filterUnwantedDecorators.js | 20 - .../filterUnwantedDecorators.spec.js | 46 --- docs/angular.io-package/rendering/toId.js | 8 - .../rendering/trimBlankLines.js | 12 - .../rendering/trimBlankLines.spec.js | 18 - .../services/renderMarkdown.js | 54 --- .../templates/class.template.html | 62 --- .../templates/enum.template.html | 1 - .../templates/function.template.html | 22 - .../templates/jade-data.template.html | 17 - .../templates/layout/base.template.html | 1 - .../templates/lib/paramList.html | 12 - .../templates/module.template.html | 15 - .../templates/var.template.html | 12 - docs/app/css/app.css | 379 ------------------ docs/app/css/prettify-theme.css | 142 ------- docs/app/index.html | 55 --- docs/app/js/app.js | 46 --- docs/app/js/code.js | 15 - docs/bower.json | 20 - docs/docs-package/index.js | 117 ------ docs/docs-package/mocks/importedSrc.ts | 1 - docs/docs-package/mocks/mockPackage.js | 10 - docs/docs-package/mocks/testSrc.ts | 34 -- .../processors/checkUnbalancedBackTicks.js | 28 -- .../convertPrivateClassesToInterfaces.js | 10 - .../processors/createOverviewDump.js | 24 -- .../processors/extractTitleFromGuides.js | 24 -- .../processors/generateNavigationDoc.js | 68 ---- docs/docs-package/readers/ngdoc.js | 32 -- docs/docs-package/readers/ngdoc.spec.js | 45 --- .../templates/class.template.html | 44 -- .../templates/common.template.html | 9 - .../templates/const.template.html | 1 - .../templates/data-module.template.js | 3 - .../templates/function.template.html | 11 - .../templates/guide.template.html | 5 - .../templates/interface.template.html | 1 - .../templates/layout/base.template.html | 1 - .../templates/lib/githubLinks.html | 3 - .../docs-package/templates/lib/paramList.html | 7 - .../templates/module.template.html | 19 - .../templates/overview-dump.template.html | 43 -- .../templates/type-alias.template.html | 10 - docs/docs-package/templates/var.template.html | 10 - docs/links-package/index.js | 12 - docs/links-package/inline-tag-defs/link.js | 33 -- docs/links-package/services/getLinkInfo.js | 72 ---- docs/public-docs-package/index.js | 24 -- gulpfile.js | 104 +---- scripts/ci/build_js.sh | 1 - 55 files changed, 3 insertions(+), 1996 deletions(-) delete mode 100644 docs/angular.io-package/index.js delete mode 100644 docs/angular.io-package/mocks/mockPackage.js delete mode 100644 docs/angular.io-package/processors/addJadeDataDocsProcessor.js delete mode 100644 docs/angular.io-package/processors/addJadeDataDocsProcessor.spec.js delete mode 100644 docs/angular.io-package/processors/filterUnwantedDecorators.js delete mode 100644 docs/angular.io-package/processors/filterUnwantedDecorators.spec.js delete mode 100644 docs/angular.io-package/rendering/toId.js delete mode 100644 docs/angular.io-package/rendering/trimBlankLines.js delete mode 100644 docs/angular.io-package/rendering/trimBlankLines.spec.js delete mode 100644 docs/angular.io-package/services/renderMarkdown.js delete mode 100644 docs/angular.io-package/templates/class.template.html delete mode 100644 docs/angular.io-package/templates/enum.template.html delete mode 100644 docs/angular.io-package/templates/function.template.html delete mode 100644 docs/angular.io-package/templates/jade-data.template.html delete mode 100644 docs/angular.io-package/templates/layout/base.template.html delete mode 100644 docs/angular.io-package/templates/lib/paramList.html delete mode 100644 docs/angular.io-package/templates/module.template.html delete mode 100644 docs/angular.io-package/templates/var.template.html delete mode 100644 docs/app/css/app.css delete mode 100644 docs/app/css/prettify-theme.css delete mode 100644 docs/app/index.html delete mode 100644 docs/app/js/app.js delete mode 100644 docs/app/js/code.js delete mode 100644 docs/bower.json delete mode 100644 docs/docs-package/index.js delete mode 100644 docs/docs-package/mocks/importedSrc.ts delete mode 100644 docs/docs-package/mocks/mockPackage.js delete mode 100644 docs/docs-package/mocks/testSrc.ts delete mode 100644 docs/docs-package/processors/checkUnbalancedBackTicks.js delete mode 100644 docs/docs-package/processors/convertPrivateClassesToInterfaces.js delete mode 100644 docs/docs-package/processors/createOverviewDump.js delete mode 100644 docs/docs-package/processors/extractTitleFromGuides.js delete mode 100644 docs/docs-package/processors/generateNavigationDoc.js delete mode 100644 docs/docs-package/readers/ngdoc.js delete mode 100644 docs/docs-package/readers/ngdoc.spec.js delete mode 100644 docs/docs-package/templates/class.template.html delete mode 100644 docs/docs-package/templates/common.template.html delete mode 100644 docs/docs-package/templates/const.template.html delete mode 100644 docs/docs-package/templates/data-module.template.js delete mode 100644 docs/docs-package/templates/function.template.html delete mode 100644 docs/docs-package/templates/guide.template.html delete mode 100644 docs/docs-package/templates/interface.template.html delete mode 100644 docs/docs-package/templates/layout/base.template.html delete mode 100644 docs/docs-package/templates/lib/githubLinks.html delete mode 100644 docs/docs-package/templates/lib/paramList.html delete mode 100644 docs/docs-package/templates/module.template.html delete mode 100644 docs/docs-package/templates/overview-dump.template.html delete mode 100644 docs/docs-package/templates/type-alias.template.html delete mode 100644 docs/docs-package/templates/var.template.html delete mode 100644 docs/links-package/index.js delete mode 100644 docs/links-package/inline-tag-defs/link.js delete mode 100644 docs/links-package/services/getLinkInfo.js delete mode 100644 docs/public-docs-package/index.js diff --git a/docs/angular.io-package/index.js b/docs/angular.io-package/index.js deleted file mode 100644 index 9d419278b6..0000000000 --- a/docs/angular.io-package/index.js +++ /dev/null @@ -1,76 +0,0 @@ -var path = require('canonical-path'); -var Package = require('dgeni').Package; -var basePackage = require('../public-docs-package'); - -var PARTIAL_PATH = 'partials'; -var MODULES_DOCS_PATH = PARTIAL_PATH + '/api'; - -module.exports = new Package('angular.io', [basePackage]) - -.factory(require('./services/renderMarkdown')) -.processor(require('./processors/addJadeDataDocsProcessor')) -.processor(require('./processors/filterUnwantedDecorators')) - -// Configure rendering -.config(function(templateFinder, templateEngine) { - - templateFinder.templateFolders - .unshift(path.resolve(__dirname, 'templates')); -}) - -.config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = 'dist/angular.io'; -}) - -.config(function(readFilesProcessor, generateNavigationDoc, createOverviewDump) { - // Clear out unwanted processors - readFilesProcessor.$enabled = false; - generateNavigationDoc.$enabled = false; - createOverviewDump.$enabled = false; -}) - - -.config(function(filterUnwantedDecorators, log) { - log.level = 'info'; - filterUnwantedDecorators.decoratorsToIgnore = [ - 'CONST', - 'IMPLEMENTS', - 'ABSTRACT' - ]; -}) - - -.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) { - - computePathsProcessor.pathTemplates.push({ - docTypes: ['module'], - pathTemplate: '${id}/', - outputPathTemplate: MODULES_DOCS_PATH + '/${id}/index.jade' - }); - - computePathsProcessor.pathTemplates.push({ - docTypes: EXPORT_DOC_TYPES, - pathTemplate: '${moduleDoc.id}/${name}-${docType}.html', - outputPathTemplate: MODULES_DOCS_PATH + '/${moduleDoc.id}/${name}-${docType}.jade', - }); - - computePathsProcessor.pathTemplates.push({ - docTypes: ['jade-data'], - pathTemplate: '${originalDoc.id}/_data', - outputPathTemplate: MODULES_DOCS_PATH + '/${path}.json' - }); -}) - -.config(function(getLinkInfo) { - getLinkInfo.relativeLinks = true; -}) - - -.config(function(templateEngine, getInjectables) { - templateEngine.filters = templateEngine.filters.concat(getInjectables([ - require('./rendering/trimBlankLines'), - require('./rendering/toId') - ])); -}); - - diff --git a/docs/angular.io-package/mocks/mockPackage.js b/docs/angular.io-package/mocks/mockPackage.js deleted file mode 100644 index 473bc36adb..0000000000 --- a/docs/angular.io-package/mocks/mockPackage.js +++ /dev/null @@ -1,8 +0,0 @@ -var Package = require('dgeni').Package; - -module.exports = function mockPackage() { - - return new Package('mockPackage', [require('../')]) - - .factory('log', function() { return require('dgeni/lib/mocks/log')(false); }) -}; diff --git a/docs/angular.io-package/processors/addJadeDataDocsProcessor.js b/docs/angular.io-package/processors/addJadeDataDocsProcessor.js deleted file mode 100644 index 0e72149a49..0000000000 --- a/docs/angular.io-package/processors/addJadeDataDocsProcessor.js +++ /dev/null @@ -1,86 +0,0 @@ -var _ = require('lodash'); -var path = require('canonical-path'); - -var titleCase = function(text) { - return text.replace(/(.)(.*)/, function(_, first, rest) { - return first.toUpperCase() + rest; - }); -}; - -/* -* Create _data.json file for Harp pages -* -* http://harpjs.com/docs/development/metadata -* -* This method creates the meta data required for each page -* such as the title, description, etc. This meta data is used -* in the harp static site generator to create the title for headers -* and the navigation used in the API docs -* -*/ - -module.exports = function addJadeDataDocsProcessor() { - return { - $runAfter: ['adding-extra-docs'], - $runBefore: ['extra-docs-added'], - $process: function(docs) { - var extraDocs = []; - var modules = []; - - - /* - * Create Data for Modules - * - * Modules must be public and have content - */ - - _.forEach(docs, function(doc) { - if (doc.docType === 'module' && !doc.private && doc.exports.length) { - modules.push(doc); - - // GET DATA FOR INDEX PAGE OF MODULE SECTION - var indexPageInfo = [{ - name: 'index', - title: _.map(path.basename(doc.fileInfo.baseName).split('_'), function(part) { - return titleCase(part); - }).join(' '), - intro: doc.description.replace('"', '\"').replace(/\s*(\r?\n|\r)\s*/g," "), - docType: 'module' - }]; - - // GET DATA FOR EACH PAGE (CLASS, VARS, FUNCTIONS) - var modulePageInfo = _(doc.exports) - .map(function(exportDoc) { - var dataDoc = { - name: exportDoc.name + '-' + exportDoc.docType, - title: exportDoc.name, - docType: exportDoc.docType - }; - if (exportDoc.symbolTypeName) dataDoc.varType = titleCase(exportDoc.symbolTypeName); - if (exportDoc.originalModule) dataDoc.originalModule = exportDoc.originalModule; - return dataDoc; - }) - .sortBy('name') - .value(); - - - - //COMBINE PAGE DATA - var allPageData = indexPageInfo.concat(modulePageInfo); - - // PUSH DATA TO EXTRA DOCS ARRAY - extraDocs.push({ - id: doc.id + "-data", - aliases: [doc.id + "-data"], - docType: 'jade-data', - originalDoc: doc, - data: allPageData - }); - } - }); - - - return docs.concat(extraDocs); - } - }; -}; diff --git a/docs/angular.io-package/processors/addJadeDataDocsProcessor.spec.js b/docs/angular.io-package/processors/addJadeDataDocsProcessor.spec.js deleted file mode 100644 index cc88c42fc4..0000000000 --- a/docs/angular.io-package/processors/addJadeDataDocsProcessor.spec.js +++ /dev/null @@ -1,66 +0,0 @@ -var mockPackage = require('../mocks/mockPackage'); -var Dgeni = require('dgeni'); - -describe('addJadeDataDocsProcessor', function() { - var dgeni, injector, processor; - - beforeEach(function() { - dgeni = new Dgeni([mockPackage()]); - injector = dgeni.configureInjector(); - processor = injector.get('addJadeDataDocsProcessor'); - }); - - it('should add a doc for each module', function() { - var docs = [ - { - docType: 'module', - id: 'someModule', - exports: [ - { name: 'someObj', docType: 'var', symbolTypeName: 'MyClass', originalModule: 'some/private/module' } - ], - fileInfo: { baseName: 'x_y' }, - description: 'some description\nsecond line' - } - ]; - docs = processor.$process(docs); - - expect(docs[1]).toEqual({ - id : 'someModule-data', - aliases : [ 'someModule-data' ], - docType : 'jade-data', - originalDoc : docs[0], - data : [ - { name : 'index', title : 'X Y', intro : 'some description second line', docType : 'module' }, - { name : 'someObj-var', title : 'someObj', varType : 'MyClass', docType: 'var', originalModule: 'some/private/module' } - ] }); - }); - - it('should sort the exports into alphabetical order', function() { - var docs = [ - { - docType: 'module', - id: 'someModule', - exports: [ - { name: 'Beta', docType: 'class'}, - { name: 'Alpha', docType: 'class'}, - { name: 'Gamma', docType: 'class'}, - { name: 'Nu', docType: 'class'}, - { name: 'Mu', docType: 'class'} - ], - fileInfo: { baseName: 'x_y' }, - description: 'some description\nsecond line' - } - ]; - docs = processor.$process(docs); - - expect(docs[1].data).toEqual([ - { name : 'index', title : 'X Y', intro : 'some description second line', docType : 'module' }, - { name: 'Alpha-class', title: 'Alpha', docType: 'class' }, - { name: 'Beta-class', title: 'Beta', docType: 'class' }, - { name: 'Gamma-class', title: 'Gamma', docType: 'class' }, - { name: 'Mu-class', title: 'Mu', docType: 'class' }, - { name: 'Nu-class', title: 'Nu', docType: 'class' } - ]); - - }); -}); diff --git a/docs/angular.io-package/processors/filterUnwantedDecorators.js b/docs/angular.io-package/processors/filterUnwantedDecorators.js deleted file mode 100644 index f790cb6d91..0000000000 --- a/docs/angular.io-package/processors/filterUnwantedDecorators.js +++ /dev/null @@ -1,20 +0,0 @@ -var _ = require('lodash'); - -module.exports = function filterUnwantedDecorators() { - return { - decoratorsToIgnore: [], - $runAfter: ['processing-docs'], - $runBefore: ['docs-processed'], - $process: function(docs) { - var decoratorsToIgnore = this.decoratorsToIgnore || []; - _.forEach(docs, function(doc) { - if (doc.decorators) { - doc.decorators = _.filter(doc.decorators, function(decorator) { - return decoratorsToIgnore.indexOf(decorator.name) === -1; - }); - } - }); - return docs; - } - }; -} diff --git a/docs/angular.io-package/processors/filterUnwantedDecorators.spec.js b/docs/angular.io-package/processors/filterUnwantedDecorators.spec.js deleted file mode 100644 index c240e6f02a..0000000000 --- a/docs/angular.io-package/processors/filterUnwantedDecorators.spec.js +++ /dev/null @@ -1,46 +0,0 @@ -var mockPackage = require('../mocks/mockPackage'); -var Dgeni = require('dgeni'); - -describe('filterUnwantedDecorators', function() { - var dgeni, injector, processor; - - beforeEach(function() { - dgeni = new Dgeni([mockPackage()]); - injector = dgeni.configureInjector(); - processor = injector.get('filterUnwantedDecorators'); - }); - - - it('should remove decorators specified by name', function() { - var docs = [ - { id: 'doc1', decorators: [ { name: 'A' }, { name: 'B' } ] }, - { id: 'doc2', decorators: [ { name: 'B' }, { name: 'C' } ] }, - { id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] } - ]; - processor.decoratorsToIgnore = ['D', 'B']; - docs = processor.$process(docs); - - expect(docs).toEqual([ - { id: 'doc1', decorators: [ { name: 'A' } ] }, - { id: 'doc2', decorators: [ { name: 'C' } ] }, - { id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] } - ]); - }); - - - it('should ignore docs that have no decorators', function() { - var docs = [ - { id: 'doc1', decorators: [ { name: 'A' }, { name: 'B' } ] }, - { id: 'doc2' }, - { id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] } - ]; - processor.decoratorsToIgnore = ['D', 'B']; - docs = processor.$process(docs); - - expect(docs).toEqual([ - { id: 'doc1', decorators: [ { name: 'A' } ] }, - { id: 'doc2' }, - { id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] } - ]); - }); -}); diff --git a/docs/angular.io-package/rendering/toId.js b/docs/angular.io-package/rendering/toId.js deleted file mode 100644 index 4b6f33f7c5..0000000000 --- a/docs/angular.io-package/rendering/toId.js +++ /dev/null @@ -1,8 +0,0 @@ -module.exports = function() { - return { - name: 'toId', - process: function(str) { - return str.replace(/[^(a-z)(A-Z)(0-9)._-]/, '-'); - } - }; -}; \ No newline at end of file diff --git a/docs/angular.io-package/rendering/trimBlankLines.js b/docs/angular.io-package/rendering/trimBlankLines.js deleted file mode 100644 index 510c7617ac..0000000000 --- a/docs/angular.io-package/rendering/trimBlankLines.js +++ /dev/null @@ -1,12 +0,0 @@ -module.exports = function() { - return { - name: 'trimBlankLines', - process: function(str) { - var lines = str.split(/\r?\n/); - while(lines.length && (lines[0].trim() === '')) { - lines.shift(); - } - return lines.join('\n'); - } - }; -}; \ No newline at end of file diff --git a/docs/angular.io-package/rendering/trimBlankLines.spec.js b/docs/angular.io-package/rendering/trimBlankLines.spec.js deleted file mode 100644 index 762fc9fd2e..0000000000 --- a/docs/angular.io-package/rendering/trimBlankLines.spec.js +++ /dev/null @@ -1,18 +0,0 @@ -var factory = require('./trimBlankLines'); - -describe('trimBlankLines filter', function() { - var filter; - - beforeEach(function() { - filter = factory(); - }); - - it('should be called "trimBlankLines"', function() { - expect(filter.name).toEqual('trimBlankLines'); - }); - - it('should remove all empty lines from the start of the string', function() { - expect(filter.process('\n\n\nsome text\n\nmore text\n\n')) - .toEqual('some text\n\nmore text\n\n'); - }); -}); \ No newline at end of file diff --git a/docs/angular.io-package/services/renderMarkdown.js b/docs/angular.io-package/services/renderMarkdown.js deleted file mode 100644 index 74d4ee1ac8..0000000000 --- a/docs/angular.io-package/services/renderMarkdown.js +++ /dev/null @@ -1,54 +0,0 @@ -var marked = require('marked'); -var Encoder = require('node-html-encoder').Encoder; -var html2jade = require('html2jade'); -var indentString = require('indent-string'); - - -function stripTags(s) { //from sugar.js - return s.replace(RegExp('<\/?[^<>]*>', 'gi'), ''); -} - -// entity type encoder -var encoder = new Encoder('entity'); - - - -/** - * @dgService renderMarkdown - * @description - * Render the markdown in the given string as HTML. - */ -module.exports = function renderMarkdown(trimIndentation) { - - var renderer = new marked.Renderer(); - - renderer.code = function(code, lang, escaped) { - - var cssClasses = ['prettyprint', 'linenums']; - var trimmedCode = trimIndentation(code); - - if(lang) { - if(lang=='html') { - trimmedCode = encoder.htmlEncode(trimmedCode); - } - cssClasses.push(this.options.langPrefix + escape(lang, true)); - } - - return 'pre(class="' + cssClasses.join(' ') + '")\n' + indentString('code.\n', ' ', 2) + trimmedCode; - }; - - renderer.heading = function (text, level, raw) { - var headingText = marked.Renderer.prototype.heading.call(renderer, text, level, raw); - var title = 'h2 ' + stripTags(headingText); - - if (level==2) { - title = '.l-main-section\n' + indentString(title, ' ', 2) ; - } - - return title; - }; - - return function(content) { - return marked(content, { renderer: renderer }); - }; -}; \ No newline at end of file diff --git a/docs/angular.io-package/templates/class.template.html b/docs/angular.io-package/templates/class.template.html deleted file mode 100644 index bbb78f24be..0000000000 --- a/docs/angular.io-package/templates/class.template.html +++ /dev/null @@ -1,62 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% include "lib/paramList.html" -%} -{% extends 'layout/base.template.html' -%} - -{% block body %} -p.location-badge. - exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } - defined in {$ githubViewLink(doc) $} - -:markdown -{$ doc.description | indent(2, true) | trimBlankLines $} - -{%- if doc.decorators %} -.l-main-section - h2 Annotations -{%- for decorator in doc.decorators %} - .l-sub-section - h3.annotation {$ decorator.name $} - pre.prettyprint - code. - @{$ decorator.name $}{$ paramList(decorator.arguments) | indent(8, false) $} -{% endfor %} -{% endif -%} - - -{%- if doc.constructorDoc or doc.members.length -%} -.l-main-section - h2 Members - -{%- if doc.constructorDoc %} - .l-sub-section - h3#{$ doc.constructorDoc.name | toId $} {$ doc.constructorDoc.name $} - - {% if doc.constructorDoc.parameters %} - pre.prettyprint - code. - {$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $} - {% endif %} - :markdown -{$ doc.constructorDoc.description | indent(6, true) | replace('## Example', '') | replace('# Example', '') | trimBlankLines $} - - -{% endif -%} - -{%- for member in doc.members %}{% if not member.private %} - .l-sub-section - h3#{$ member.name | toId $} {$ member.name $}{% if member.optional %}?{% endif %} - - {% if member.parameters %} - pre.prettyprint - code. - {$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(doc.returnType) $} - {% endif %} - :markdown -{$ member.description | indent(6, true) | replace('## Example', '') | replace('# Example', '') | trimBlankLines $} - - - -{% endif %}{% endfor %} -{%- endif -%} - -{% endblock %} diff --git a/docs/angular.io-package/templates/enum.template.html b/docs/angular.io-package/templates/enum.template.html deleted file mode 100644 index 9c59159b29..0000000000 --- a/docs/angular.io-package/templates/enum.template.html +++ /dev/null @@ -1 +0,0 @@ -{% extends 'class.template.html' -%} \ No newline at end of file diff --git a/docs/angular.io-package/templates/function.template.html b/docs/angular.io-package/templates/function.template.html deleted file mode 100644 index 5136a35021..0000000000 --- a/docs/angular.io-package/templates/function.template.html +++ /dev/null @@ -1,22 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% include "lib/paramList.html" -%} -{% extends 'layout/base.template.html' -%} - -{% block body %} -.l-main-section - h2(class="function export") {$ doc.name $} - - {% if doc.parameters %} - pre.prettyprint - code. - {$ doc.name $}{$ paramList(doc.parameters) | indent(4, true) | trim $}{$ returnType(doc.returnType) $} - {% endif %} - - p.location-badge. - exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } - defined in {$ githubViewLink(doc) $} - - :markdown -{$ doc.description | indent(4, true) | trimBlankLines $} - -{% endblock %} \ No newline at end of file diff --git a/docs/angular.io-package/templates/jade-data.template.html b/docs/angular.io-package/templates/jade-data.template.html deleted file mode 100644 index a8c95ab1ee..0000000000 --- a/docs/angular.io-package/templates/jade-data.template.html +++ /dev/null @@ -1,17 +0,0 @@ -{ -{%- for item in doc.data %} - "{$ item.name $}" : { - "title" : "{$ item.title $}", - {%- if item.intro %} - "intro" : "{$ item.intro $}", - {%- endif %} - {%- if item.varType %} - "varType" : "{$ item.varType $}", - {%- endif %} - {%- if item.originalModule %} - "originalModule" : "{$ item.originalModule $}", - {%- endif %} - "docType": "{$ item.docType $}" - }{% if not loop.last %},{% endif %} -{% endfor -%} -} diff --git a/docs/angular.io-package/templates/layout/base.template.html b/docs/angular.io-package/templates/layout/base.template.html deleted file mode 100644 index 16a0d9dc96..0000000000 --- a/docs/angular.io-package/templates/layout/base.template.html +++ /dev/null @@ -1 +0,0 @@ -{% block body %}{% endblock %} \ No newline at end of file diff --git a/docs/angular.io-package/templates/lib/paramList.html b/docs/angular.io-package/templates/lib/paramList.html deleted file mode 100644 index 24ba12c080..0000000000 --- a/docs/angular.io-package/templates/lib/paramList.html +++ /dev/null @@ -1,12 +0,0 @@ -{% macro paramList(params) -%} - {%- if params -%} - ({%- for param in params -%} - {$ param | escape $}{% if not loop.last %}, {% endif %} - {%- endfor %}) - {%- endif %} -{%- endmacro -%} - - -{% macro returnType(returnType) -%} - {%- if returnType %} : {$ returnType | escape $}{% endif -%} -{%- endmacro -%} diff --git a/docs/angular.io-package/templates/module.template.html b/docs/angular.io-package/templates/module.template.html deleted file mode 100644 index 3fbe568783..0000000000 --- a/docs/angular.io-package/templates/module.template.html +++ /dev/null @@ -1,15 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' -%} -{% block body -%} -p.location-badge. - defined in {$ githubViewLink(doc) $} - -ul - for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data - if slug != 'index' - - var url = "/docs/" + current.path[1] + "/" + current.path[2] + "/" + current.path[3] + "/" + current.path[4] + "/" + slug + ".html" - - li.c8 - != partial("../../../../../_includes/_hover-card", {name: page.title, url: url }) - -{% endblock %} \ No newline at end of file diff --git a/docs/angular.io-package/templates/var.template.html b/docs/angular.io-package/templates/var.template.html deleted file mode 100644 index 72aa66ecfd..0000000000 --- a/docs/angular.io-package/templates/var.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' %} - -{% block body %} -.l-main-section - p.location-badge. - exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } - defined in {$ githubViewLink(doc) $} - - :markdown -{$ doc.description | indent(4, true) | trimBlankLines $} -{% endblock %} diff --git a/docs/app/css/app.css b/docs/app/css/app.css deleted file mode 100644 index ac23dd0c82..0000000000 --- a/docs/app/css/app.css +++ /dev/null @@ -1,379 +0,0 @@ - -.hide { display: none !important; } - -body { - overflow: hidden; - max-width: 100%; - max-height: 100%; - font-size: 14px; -} - -a { - color: #3f51b5; -} - -table { - margin-bottom: 20px; - max-width: 100%; - width: 100%; - border-spacing: 0; - border-collapse: collapse; - background-color: transparent; -} - -td, -th { - padding: $baseline-grid ($baseline-grid * 2); - border-top: 1px solid #ddd; - vertical-align: top; -} - -th { - border-bottom: 2px solid #ddd; - vertical-align: bottom; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -.md-sidenav-inner { - background: #fff; -} - -.layout-content, -.doc-content { - max-width: 864px; - margin: auto; -} -.layout-label { - width: 120px; -} -.layout-content code.highlight { - margin-bottom: 15px; -} - -.menu-item { - background: none; - border-width: 0; - cursor: pointer; - display: block; - color: #333; - font-size: inherit; - line-height: 40px; - max-height: 40px; - opacity: 1; - margin: 0; - outline: none; - padding: 0px 28px; - position: relative; - text-align: left; - text-decoration: none; - width: 100%; - z-index: 1; - -webkit-transition: 0.45s cubic-bezier(0.35, 0, 0.25, 1); - -webkit-transition-property: max-height, background-color, opacity; - -moz-transition: 0.45s cubic-bezier(0.35, 0, 0.25, 1); - -moz-transition-property: max-height, background-color, opacity; - transition: 0.45s cubic-bezier(0.35, 0, 0.25, 1); - transition-property: max-height, background-color, opacity; -} -.menu-item.ng-hide { - max-height: 0; - opacity: 0; -} -.menu-item:hover { - color: #999; -} -.menu-item:focus { - font-weight: bold; -} -.menu-item.menu-title { - color: #888; - font-size: 14px; - padding-left: 16px; - text-align: left; - text-transform: uppercase; - transition: color 0.35s cubic-bezier(0.35, 0, 0.25, 1); -} -.menu-item.menu-title:hover, -.menu-item.menu-title.active { - color: #1976d2; -} - -.menu-icon { - background: none; - border: none; -} -.app-toolbar .md-toolbar-tools h3 { - -webkit-margin-before: 0; - -webkit-margin-after: 0; -} - -.demo-container { - border-radius: 4px; - margin-top: 16px; - -webkit-transition: 0.02s padding cubic-bezier(0.35, 0, 0.25, 1); - transition: 0.02s padding cubic-bezier(0.35, 0, 0.25, 1); - position: relative; - padding-bottom: 0; -} -.demo-source-tabs { - z-index: 1; - -webkit-transition: all 0.45s cubic-bezier(0.35, 0, 0.25, 1); - transition: all 0.45s cubic-bezier(0.35, 0, 0.25, 1); - max-height: 448px; - min-height: 448px; - background: #fff; - overflow: hidden; -} - -md-tabs.demo-source-tabs md-tab, -md-tabs.demo-source-tabs .md-header { - background-color: #444444 !important; -} - - -md-tabs.demo-source-tabs md-tab-label { - color: #ccc !important; -} - -md-tabs.demo-source-tabs .active md-tab-label { - color: #fff !important; -} - -.demo-source-tabs.ng-hide { - max-height: 0px; - min-height: 0px; -} -.demo-source-tabs { - position: relative; - width: 100%; - z-index: 0; -} -.demo-content { - position: relative; - overflow:hidden; - min-height: 448px; - display: -webkit-box; - display: -webkit-flex; - display: -moz-box; - display: -moz-flex; - display: -ms-flexbox; - display: flex; -} -.small-demo .demo-source-tabs:not(.ng-hide) { - min-height: 224px; - max-height: 224px; -} -.small-demo .demo-content { - min-height: 128px; -} -.demo-content > * { - -webkit-box-flex: 1; - -webkit-flex: 1; - -moz-box-flex: 1; - -moz-flex: 1; - -ms-flex: 1; - flex: 1; -} - -.demo-content > div[layout-fill] { - min-height: 448px; -} -.small-demo .demo-content > div[layout-fill] { - min-height: 224px; -} -.small-demo .demo-toolbar, -.small-demo .md-toolbar-tools { - min-height: 48px; - max-height: 48px; - font-size: 20px; -} - -.show-source md-toolbar.demo-toolbar { - box-shadow: 0 1px 3px 0 rgba(0, 0, 0, 0.36); -} -.demo-toolbar .md-button { - color: #616161; -} - -md-toolbar.demo-toolbar, -.demo-source-tabs md-tab, -.demo-source-tabs .tabs-header { - background: #E0E0E0 !important; - color: #616161; -} -md-toolbar.demo-toolbar md-tab-label { - color: #99E4EE -} -md-toolbar.demo-toolbar .md-button:hover, -md-toolbar.demo-toolbar .md-button:focus, -md-toolbar.demo-toolbar .md-button.active { - background: rgba(0,0,0,0.1); -} - -md-toolbar.demo-toolbar .md-button { - -webkit-transition: all 0.3s linear; - -moz-transition: all 0.3s linear; - transition: all 0.3s linear; -} -.demo-source-container { - display: block; - border: 1px solid #ddd; - background-color: #f6f6f6; - height: 400px; -} - -.demo-source-content { - height: 400px; -} -.demo-source-content, -.demo-source-content pre, -.demo-source-content code { - background: #f6f6f6; - font-family: monospace; -} -.demo-source-content pre { - max-width: 100%; - overflow-wrap: break-word; -} - -.show-source div[demo-include] { - border-top: #ddd solid 2px; -} - - -.menu-separator-icon { - margin: 0; -} -.menu-module-name { - opacity: 0.6; - font-size: 18px; -} - -/************ - * DOCS - ************/ -.api-options-bar .md-button { - margin: 4px; - padding: 4px; -} -.api-options-bar .md-button:hover, -.api-options-bar .md-button:focus { - background: rgba(0, 0, 0, 0.2); -} -.api-options-bar.with-icon md-icon { - position: absolute; - top: -3px; - left: 2px; -} -.api-options-bar.with-icon .md-button span { - margin-left: 22px; -} - -.api-params-item { - min-height: 72px; - border-bottom: 1px solid #ddd; -} -.api-params-label { - margin-right: 8px; - text-align: center; - margin-top: 14px; - -webkit-align-self: flex-start; - -moz-align-self: flex-start; - -ms-flex-item-align: start; - align-self: flex-start; -} -.api-params-title { - color: #888; -} -code.api-type { - font-weight: bold; -} - -ul { - margin: 0; -} -ul li { - margin-top: 3px; - list-style-position: inside; -} -ul li:first-child { - margin-top: 0; -} - -.layout-title { - color: #999999; - font-size: 14px; - font-weight: bold; - text-transform: uppercase; -} - -.api-params-content ul { - padding-left: 4px; -} -ul.methods > li { - margin-bottom: 48px; -} - -ul.methods .method-function-syntax { - font-weight: normal; - font-size: 20px; - margin: 0; - -webkit-margin-before: 0; - -webkit-margin-after: 0; -} -ul.methods li h3 { - /* border-bottom: 1px solid #eee; */ -} - -@media (max-width: 600px) { - ul.methods > li { - padding-left: 0; - border-left: none; - list-style: default; - } - ul.methods .method-function-syntax { - font-size: 14px; - } -} - -.version { - padding-left: 10px; - text-decoration: underline; - font-size: 0.95em; -} - -.demo-source-container pre, -.demo-source-container code { - min-height: 100%; -} - -md-content.demo-source-container > hljs > pre > code.highlight { - position : absolute; - top : 0px; - left: 0px; - right: 0px; -} - - -.extraPad { - padding-left:32px !important; - padding-right:32px !important; -} - - -.member .name { - white-space: pre-wrap; - word-wrap: break-word; - font-family: monospace; - font-size: 1.17em; - margin: 1em 0; -} - -.left-nav { - min-width: 300px; -} \ No newline at end of file diff --git a/docs/app/css/prettify-theme.css b/docs/app/css/prettify-theme.css deleted file mode 100644 index 7308e1ec71..0000000000 --- a/docs/app/css/prettify-theme.css +++ /dev/null @@ -1,142 +0,0 @@ -/* GitHub Theme */ -.prettyprint { - background: white; - font-family: Menlo, 'Bitstream Vera Sans Mono', 'DejaVu Sans Mono', Monaco, Consolas, monospace; - font-size: 12px; - line-height: 1.5; -} - -.lang-text * { - color: #333333!important; -} - -.pln { - color: #333333; -} - -@media screen { - .str { - color: #dd1144; - } - - .kwd { - color: #333333; - } - - .com { - color: #999988; - } - - .typ { - color: #445588; - } - - .lit { - color: #445588; - } - - .pun { - color: #333333; - } - - .opn { - color: #333333; - } - - .clo { - color: #333333; - } - - .tag { - color: navy; - } - - .atn { - color: teal; - } - - .atv { - color: #dd1144; - } - - .dec { - color: #333333; - } - - .var { - color: teal; - } - - .fun { - color: #990000; - } -} -@media print, projection { - .str { - color: #006600; - } - - .kwd { - color: #006; - font-weight: bold; - } - - .com { - color: #600; - font-style: italic; - } - - .typ { - color: #404; - font-weight: bold; - } - - .lit { - color: #004444; - } - - .pun, .opn, .clo { - color: #444400; - } - - .tag { - color: #006; - font-weight: bold; - } - - .atn { - color: #440044; - } - - .atv { - color: #006600; - } -} -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; -} - -/* IE indents via margin-left */ -li.L0, -li.L1, -li.L2, -li.L3, -li.L4, -li.L5, -li.L6, -li.L7, -li.L8, -li.L9 { - /* */ -} - -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { - /* */ -} diff --git a/docs/app/index.html b/docs/app/index.html deleted file mode 100644 index 3bfb05b69e..0000000000 --- a/docs/app/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - Angular 2 Docs - - - - - - - - - - - - - - - - - - - - - -

Angular V2

- - -
- - -

Navigation

-
-

{{ area.name }}

- - -

{{section.name}}

- - - -
- - - - - - - -
- - \ No newline at end of file diff --git a/docs/app/js/app.js b/docs/app/js/app.js deleted file mode 100644 index cfdc530159..0000000000 --- a/docs/app/js/app.js +++ /dev/null @@ -1,46 +0,0 @@ -angular.module('app', ['ngMaterial', 'navigation-modules', 'navigation-guides', 'code']) - -.config(function($locationProvider) { - $locationProvider.html5Mode(true); -}) - -.controller('NavController', ['$scope', '$location', 'MODULES', 'GUIDES', - function($scope, $location, MODULES, GUIDES) { - var that = this; - - this.areas = [ - { name: 'Guides', sections: [ { pages: GUIDES.pages } ] }, - { name: 'Modules', sections: MODULES.sections } - ]; - - this.updateCurrentPage = function(path) { - console.log('path', path); - this.currentPage = null; - - this.areas.forEach(function(area) { - area.sections.forEach(function(section) { - - // Short-circuit out if the page has been found - if ( that.currentPage ) { - return; - } - - if (section.path === path) { - console.log('found!'); - that.currentPage = section; - } else { - section.pages.forEach(function(page) { - if (page.path === path) { - that.currentPage = page; - } - }); - } - }); - }); - }; - - $scope.$watch( - function getLocationPath() { return $location.path(); }, - function handleLocationPathChange(path) { that.updateCurrentPage(path); } - ); -}]); diff --git a/docs/app/js/code.js b/docs/app/js/code.js deleted file mode 100644 index 0550459d50..0000000000 --- a/docs/app/js/code.js +++ /dev/null @@ -1,15 +0,0 @@ -angular.module('code', []) - -.directive('code', function() { - return { - restrict: 'E', - terminal: true, - compile: function(element) { - var linenums = element.hasClass('linenum'); - var match = /lang-(\S+)/.exec(element[0].className); - var lang = match && match[1]; - var html = element.html(); - element.html(window.prettyPrintOne(html, lang, linenums)); - } - }; -}); diff --git a/docs/bower.json b/docs/bower.json deleted file mode 100644 index 86cf418b25..0000000000 --- a/docs/bower.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "name": "angular-docs", - "main": "index.js", - "version": "0.0.0", - "homepage": "https://github.com/angular/angular", - "authors": [], - "license": "Apache-2.0", - "private": true, - "ignore": [ - "**/.*", - "node_modules", - "bower_components", - "test", - "tests" - ], - "dependencies": { - "angular-material": "~0.6.0", - "google-code-prettify": "~1.0.3" - } -} diff --git a/docs/docs-package/index.js b/docs/docs-package/index.js deleted file mode 100644 index 943cd546fe..0000000000 --- a/docs/docs-package/index.js +++ /dev/null @@ -1,117 +0,0 @@ -var Package = require('dgeni').Package; -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('canonical-path'); - -// Define the dgeni package for generating the docs -module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, gitPackage]) - -// Register the services and file readers -.factory(require('./readers/ngdoc')) - -// Register the processors -.processor(require('./processors/convertPrivateClassesToInterfaces')) -.processor(require('./processors/generateNavigationDoc')) -.processor(require('./processors/extractTitleFromGuides')) -.processor(require('./processors/createOverviewDump')) -.processor(require('./processors/checkUnbalancedBackTicks')) - -// Configure the log service -.config(function(log) { - log.level = 'warn'; -}) - - -.config(function(renderDocsProcessor, versionInfo) { - renderDocsProcessor.extraData.versionInfo = versionInfo; -}) - -// Configure file reading -.config(function(readFilesProcessor, ngdocFileReader, readTypeScriptModules) { - readFilesProcessor.fileReaders = [ngdocFileReader]; - readFilesProcessor.basePath = path.resolve(__dirname, '../..'); - readFilesProcessor.sourceFiles = [ - { include: 'modules/*/docs/**/*.md', basePath: 'modules' }, - { include: 'docs/content/**/*.md', basePath: 'docs/content' } - ]; - - readTypeScriptModules.sourceFiles = [ - '*/*.@(js|es6|ts)', - '*/src/**/*.@(js|es6|ts)' - ]; - readTypeScriptModules.basePath = path.resolve(readFilesProcessor.basePath, 'modules'); -}) - - -.config(function(parseTagsProcessor, getInjectables) { - // We actually don't want to parse param docs in this package as we are getting the data out using TS - parseTagsProcessor.tagDefinitions.forEach(function(tagDef) { - if (tagDef.name === 'param') { - tagDef.docProperty = 'paramData'; - tagDef.transforms = []; - } - }); - -}) - - -// Configure links -.config(function(getLinkInfo) { - getLinkInfo.useFirstAmbiguousLink = true; -}) - - -// Configure file writing -.config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = 'dist/docs'; -}) - - -// Configure rendering -.config(function(templateFinder, templateEngine) { - - // Nunjucks and Angular conflict in their template bindings so change Nunjucks - templateEngine.config.tags = { - variableStart: '{$', - variableEnd: '$}' - }; - - templateFinder.templateFolders - .unshift(path.resolve(__dirname, 'templates')); - - templateFinder.templatePatterns = [ - '${ doc.template }', - '${ doc.id }.${ doc.docType }.template.html', - '${ doc.id }.template.html', - '${ doc.docType }.template.html', - 'common.template.html' - ]; -}) - - -// Configure ids and paths -.config(function(computeIdsProcessor, computePathsProcessor) { - - computeIdsProcessor.idTemplates.push({ - docTypes: ['guide'], - getId: function(doc) { - return doc.fileInfo.relativePath - // path should be relative to `modules` folder - .replace(/.*\/?modules\//, '') - // path should not include `/docs/` - .replace(/\/docs\//, '/') - // path should not have a suffix - .replace(/\.\w*$/, ''); - }, - getAliases: function(doc) { return [doc.id]; } - }); - - computePathsProcessor.pathTemplates.push({ - docTypes: ['guide'], - pathTemplate: '/${id}', - outputPathTemplate: 'partials/guides/${id}.html' - }); -}); diff --git a/docs/docs-package/mocks/importedSrc.ts b/docs/docs-package/mocks/importedSrc.ts deleted file mode 100644 index 74a115e5fe..0000000000 --- a/docs/docs-package/mocks/importedSrc.ts +++ /dev/null @@ -1 +0,0 @@ -export var x = 100; \ No newline at end of file diff --git a/docs/docs-package/mocks/mockPackage.js b/docs/docs-package/mocks/mockPackage.js deleted file mode 100644 index 61d0df228a..0000000000 --- a/docs/docs-package/mocks/mockPackage.js +++ /dev/null @@ -1,10 +0,0 @@ -var Package = require('dgeni').Package; - -module.exports = function mockPackage() { - - return new Package('mockPackage', [require('../')]) - - // provide a mock log service - .factory('log', function() { return require('dgeni/lib/mocks/log')(false); }); - -}; diff --git a/docs/docs-package/mocks/testSrc.ts b/docs/docs-package/mocks/testSrc.ts deleted file mode 100644 index 7b6d3f18dd..0000000000 --- a/docs/docs-package/mocks/testSrc.ts +++ /dev/null @@ -1,34 +0,0 @@ -/** - * @module - * @description - * This is the module description - */ - -export * from 'importedSrc'; - -/** - * This is some random other comment - */ - -/** - * This is MyClass - */ -export class MyClass { - message: String; - - /** - * Create a new MyClass - * @param {String} name The name to say hello to - */ - constructor(name) { this.message = 'hello ' + name; } - - /** - * Return a greeting message - */ - greet() { return this.message; } -} - -/** - * An exported function - */ -export var myFn = (val: number) => return val * 2; \ No newline at end of file diff --git a/docs/docs-package/processors/checkUnbalancedBackTicks.js b/docs/docs-package/processors/checkUnbalancedBackTicks.js deleted file mode 100644 index 2d359c7785..0000000000 --- a/docs/docs-package/processors/checkUnbalancedBackTicks.js +++ /dev/null @@ -1,28 +0,0 @@ -var _ = require('lodash'); - -/** - * @dgProcessor checkUnbalancedBackTicks - * @description - * Searches the rendered content for an odd number of (```) backticks, - * which would indicate an unbalanced pair and potentially a typo in the - * source content. - */ -module.exports = function checkUnbalancedBackTicks(log, createDocMessage) { - - var BACKTICK_REGEX = /^ *```/gm; - - return { - $runAfter: ['checkAnchorLinksProcessor'], - $process: function(docs) { - _.forEach(docs, function(doc) { - if ( doc.renderedContent ) { - var matches = doc.renderedContent.match(BACKTICK_REGEX); - if (matches && matches.length % 2 !== 0) { - log.warn(createDocMessage('checkUnbalancedBackTicks processor: unbalanced backticks found in rendered content', doc)); - console.log(doc.renderedContent); - } - } - }); - } - }; -}; \ No newline at end of file diff --git a/docs/docs-package/processors/convertPrivateClassesToInterfaces.js b/docs/docs-package/processors/convertPrivateClassesToInterfaces.js deleted file mode 100644 index 6e6e758daa..0000000000 --- a/docs/docs-package/processors/convertPrivateClassesToInterfaces.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = function convertPrivateClassesToInterfacesProcessor(convertPrivateClassesToInterfaces) { - return { - $runAfter: ['processing-docs'], - $runBefore: ['docs-processed'], - $process: function(docs) { - convertPrivateClassesToInterfaces(docs, false); - return docs; - } - }; -}; \ No newline at end of file diff --git a/docs/docs-package/processors/createOverviewDump.js b/docs/docs-package/processors/createOverviewDump.js deleted file mode 100644 index eadd24e0af..0000000000 --- a/docs/docs-package/processors/createOverviewDump.js +++ /dev/null @@ -1,24 +0,0 @@ -var _ = require('lodash'); - -module.exports = function createOverviewDump() { - - return { - $runAfter: ['processing-docs'], - $runBefore: ['docs-processed'], - $process: function(docs) { - var overviewDoc = { - id: 'overview-dump', - aliases: ['overview-dump'], - path: 'overview-dump', - outputPath: 'overview-dump.html', - modules: [] - }; - _.forEach(docs, function(doc) { - if ( doc.docType === 'module' ) { - overviewDoc.modules.push(doc); - } - }); - docs.push(overviewDoc); - } - }; -}; \ No newline at end of file diff --git a/docs/docs-package/processors/extractTitleFromGuides.js b/docs/docs-package/processors/extractTitleFromGuides.js deleted file mode 100644 index 1a4e6c3806..0000000000 --- a/docs/docs-package/processors/extractTitleFromGuides.js +++ /dev/null @@ -1,24 +0,0 @@ -var _ = require('lodash'); - -module.exports = function extractTitleFromGuides() { - - return { - $runAfter: ['processing-docs'], - $runBefore: ['docs-processed'], - $process: function(docs) { - _(docs).forEach(function(doc) { - if (doc.docType === 'guide') { - doc.name = doc.name || getNameFromHeading(doc.description); - } - }); - } - }; -}; - - -function getNameFromHeading(text) { - var match = /^\s*#\s*(.*)/.exec(text); - if (match) { - return match[1]; - } -} \ No newline at end of file diff --git a/docs/docs-package/processors/generateNavigationDoc.js b/docs/docs-package/processors/generateNavigationDoc.js deleted file mode 100644 index 5e8ecf7149..0000000000 --- a/docs/docs-package/processors/generateNavigationDoc.js +++ /dev/null @@ -1,68 +0,0 @@ -var _ = require('lodash'); - -module.exports = function generateNavigationDoc() { - - return { - $runAfter: ['docs-processed'], - $runBefore: ['rendering-docs'], - $process: function(docs) { - var modulesDoc = { - value: { sections: [] }, - moduleName: 'navigation-modules', - serviceName: 'MODULES', - template: 'data-module.template.js', - outputPath: 'js/navigation-modules.js' - }; - - _.forEach(docs, function(doc) { - if ( doc.docType === 'module' ) { - var moduleNavItem = { - path: doc.path, - partial: doc.outputPath, - name: doc.id, - type: 'module', - pages: [] - }; - - modulesDoc.value.sections.push(moduleNavItem); - - _.forEach(doc.exports, function(exportDoc) { - if (!exportDoc.private) { - var exportNavItem = { - path: exportDoc.path, - partial: exportDoc.outputPath, - name: exportDoc.name, - type: exportDoc.docType - }; - moduleNavItem.pages.push(exportNavItem); - } - }); - } - }); - - docs.push(modulesDoc); - - - var guidesDoc = { - value: { pages: [] }, - moduleName: 'navigation-guides', - serviceName: 'GUIDES', - template: 'data-module.template.js', - outputPath: 'js/navigation-guides.js' - }; - - _.forEach(docs, function(doc) { - if ( doc.docType === 'guide' ) { - var guideDoc = { - path: doc.path, - partial: doc.outputPath, - name: doc.name, - type: 'guide' - }; - guidesDoc.value.pages.push(guideDoc); - } - }); - docs.push(guidesDoc); - } - }; -}; diff --git a/docs/docs-package/readers/ngdoc.js b/docs/docs-package/readers/ngdoc.js deleted file mode 100644 index a1e6a7e4d5..0000000000 --- a/docs/docs-package/readers/ngdoc.js +++ /dev/null @@ -1,32 +0,0 @@ -var path = require('canonical-path'); - -/** - * @dgService ngdocFileReader - * @description - * This file reader will pull the contents from a text file (by default .ngdoc) - * - * The doc will initially have the form: - * ``` - * { - * content: 'the content of the file', - * startingLine: 1 - * } - * ``` - */ -module.exports = function ngdocFileReader() { - var reader = { - name: 'ngdocFileReader', - defaultPattern: /\.md$/, - getDocs: function(fileInfo) { - - // We return a single element array because ngdoc files only contain one document - return [{ - docType: 'guide', - content: fileInfo.content, - startingLine: 1 - }]; - } - }; - - return reader; -}; \ No newline at end of file diff --git a/docs/docs-package/readers/ngdoc.spec.js b/docs/docs-package/readers/ngdoc.spec.js deleted file mode 100644 index 658663c9fb..0000000000 --- a/docs/docs-package/readers/ngdoc.spec.js +++ /dev/null @@ -1,45 +0,0 @@ -var ngdocFileReaderFactory = require('./ngdoc'); -var path = require('canonical-path'); - -describe('ngdocFileReader', function() { - - var fileReader; - - var createFileInfo = function(file, content, basePath) { - return { - fileReader: fileReader.name, - filePath: file, - baseName: path.basename(file, path.extname(file)), - extension: path.extname(file).replace(/^\./, ''), - basePath: basePath, - relativePath: path.relative(basePath, file), - content: content - }; - }; - - - beforeEach(function() { - fileReader = ngdocFileReaderFactory(); - }); - - - describe('defaultPattern', function() { - it('should match .md files', function() { - expect(fileReader.defaultPattern.test('abc.md')).toBeTruthy(); - expect(fileReader.defaultPattern.test('abc.js')).toBeFalsy(); - }); - }); - - - describe('getDocs', function() { - it('should return an object containing info about the file and its contents', function() { - var fileInfo = createFileInfo('project/path/modules/someModule/foo/docs/subfolder/bar.ngdoc', 'A load of content', 'project/path'); - expect(fileReader.getDocs(fileInfo)).toEqual([{ - docType: 'guide', - content: 'A load of content', - startingLine: 1 - }]); - }); - }); -}); - diff --git a/docs/docs-package/templates/class.template.html b/docs/docs-package/templates/class.template.html deleted file mode 100644 index a015cf5e7e..0000000000 --- a/docs/docs-package/templates/class.template.html +++ /dev/null @@ -1,44 +0,0 @@ -{% include "lib/paramList.html" -%} -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' -%} - -{% block body %} -

{$ doc.name $} {$ doc.docType $}

-

exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
-defined in {$ githubViewLink(doc) $} -

-

{$ doc.description | marked $}

- -{%- if doc.decorators %} -

Annotations

-{%- for decorator in doc.decorators %} -

@{$ decorator.name $}{$ paramList(decorator.arguments) $}

-{% endfor %} -{% endif -%} - -{%- if doc.constructorDoc or doc.members.length -%} -

Members

- -{%- if doc.constructorDoc %} -
-

{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.params) $}

- {% marked %} - {$ doc.constructorDoc.description $} - {% endmarked %} -
-{% endif -%} - -{%- for member in doc.members %}{% if not member.private %} -
-

- {$ member.name $}{% if member.optional %}?{% endif %}{$ paramList(member.params) $} -

- {% marked %} - {$ member.description $} - {% endmarked %} -
- -{% endif %}{% endfor %} -{%- endif -%} - -{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/common.template.html b/docs/docs-package/templates/common.template.html deleted file mode 100644 index dc10750a80..0000000000 --- a/docs/docs-package/templates/common.template.html +++ /dev/null @@ -1,9 +0,0 @@ -{% extends 'layout/base.template.html' %} - -{% block body %} -

{$ doc.id $}

-

({$ doc.docType $})

-
-{$ doc.description | marked $} -
-{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/const.template.html b/docs/docs-package/templates/const.template.html deleted file mode 100644 index 8b813c7d8e..0000000000 --- a/docs/docs-package/templates/const.template.html +++ /dev/null @@ -1 +0,0 @@ -{% extends 'var.template.html' -%} diff --git a/docs/docs-package/templates/data-module.template.js b/docs/docs-package/templates/data-module.template.js deleted file mode 100644 index 498cdad8cf..0000000000 --- a/docs/docs-package/templates/data-module.template.js +++ /dev/null @@ -1,3 +0,0 @@ -angular.module('{$ doc.moduleName $}', []) - -.value('{$ doc.serviceName $}', {$ doc.value | json $}); \ No newline at end of file diff --git a/docs/docs-package/templates/function.template.html b/docs/docs-package/templates/function.template.html deleted file mode 100644 index 4e6d5441f6..0000000000 --- a/docs/docs-package/templates/function.template.html +++ /dev/null @@ -1,11 +0,0 @@ -{% include "lib/paramList.html" -%} -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' -%} - -{% block body %} -

{$ doc.name $}{$ paramList(doc.parameters) $}

-

exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
-defined in {$ githubViewLink(doc) $}

-

{$ doc.description | marked $}

- -{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/guide.template.html b/docs/docs-package/templates/guide.template.html deleted file mode 100644 index 3ee289dbc8..0000000000 --- a/docs/docs-package/templates/guide.template.html +++ /dev/null @@ -1,5 +0,0 @@ -{% extends 'layout/base.template.html' %} - -{% block body %} -{$ doc.description | marked $} -{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/interface.template.html b/docs/docs-package/templates/interface.template.html deleted file mode 100644 index 3bde456ceb..0000000000 --- a/docs/docs-package/templates/interface.template.html +++ /dev/null @@ -1 +0,0 @@ -{% extends 'class.template.html' -%} diff --git a/docs/docs-package/templates/layout/base.template.html b/docs/docs-package/templates/layout/base.template.html deleted file mode 100644 index 16a0d9dc96..0000000000 --- a/docs/docs-package/templates/layout/base.template.html +++ /dev/null @@ -1 +0,0 @@ -{% block body %}{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/lib/githubLinks.html b/docs/docs-package/templates/lib/githubLinks.html deleted file mode 100644 index 574656542f..0000000000 --- a/docs/docs-package/templates/lib/githubLinks.html +++ /dev/null @@ -1,3 +0,0 @@ -{% macro githubViewLink(doc) -%} - {$ doc.fileInfo.relativePath $} (line {$ doc.location.start.line+1 $}) -{%- endmacro -%} diff --git a/docs/docs-package/templates/lib/paramList.html b/docs/docs-package/templates/lib/paramList.html deleted file mode 100644 index 85dccb212b..0000000000 --- a/docs/docs-package/templates/lib/paramList.html +++ /dev/null @@ -1,7 +0,0 @@ -{% macro paramList(params) -%} - {%- if params -%}( - {%- for param in params -%} - {$ param | escape $}{% if not loop.last %}, {% endif %} - {%- endfor %}) - {%- endif %} -{%- endmacro -%} diff --git a/docs/docs-package/templates/module.template.html b/docs/docs-package/templates/module.template.html deleted file mode 100644 index c016075c48..0000000000 --- a/docs/docs-package/templates/module.template.html +++ /dev/null @@ -1,19 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' %} - -{% block body %} -

{$ doc.id $} module

-

defined in {$ githubViewLink(doc) $}

-

{$ doc.description | marked $}

- -{% if doc.exports.length %} -

Exports

- -{% endif %} -{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/overview-dump.template.html b/docs/docs-package/templates/overview-dump.template.html deleted file mode 100644 index 3f4ee1294f..0000000000 --- a/docs/docs-package/templates/overview-dump.template.html +++ /dev/null @@ -1,43 +0,0 @@ -{% include "lib/paramList.html" -%} - - - - - - - - - -

Modules

- -{% for module in doc.modules %} - -

{$ module.id $} - {%- if module.public %} (public){% endif %}

- - {% for export in module.exports %} -

{$ export.name $}

- - {%- if export.constructorDoc %} -

{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.params) $}

- {% endif -%} - {%- for member in export.members %} -

{$ member.name $}{$ paramList(member.params) $}

- {% endfor %} - - {% endfor %} - -{% endfor %} - - - diff --git a/docs/docs-package/templates/type-alias.template.html b/docs/docs-package/templates/type-alias.template.html deleted file mode 100644 index 7f0ea6399f..0000000000 --- a/docs/docs-package/templates/type-alias.template.html +++ /dev/null @@ -1,10 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' %} - -{% block body %} -

{$ doc.name $} type alias

-

exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
-defined in {$ githubViewLink(doc) $}

-

{$ doc.description | marked $}

- -{% endblock %} \ No newline at end of file diff --git a/docs/docs-package/templates/var.template.html b/docs/docs-package/templates/var.template.html deleted file mode 100644 index 2d43873595..0000000000 --- a/docs/docs-package/templates/var.template.html +++ /dev/null @@ -1,10 +0,0 @@ -{% include "lib/githubLinks.html" -%} -{% extends 'layout/base.template.html' %} - -{% block body %} -

{$ doc.name $} variable

-

exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
-defined in {$ githubViewLink(doc) $}

-

{$ doc.description | marked $}

- -{% endblock %} \ No newline at end of file diff --git a/docs/links-package/index.js b/docs/links-package/index.js deleted file mode 100644 index a3ffc71991..0000000000 --- a/docs/links-package/index.js +++ /dev/null @@ -1,12 +0,0 @@ -var Package = require('dgeni').Package; - -module.exports = new Package('links', []) - -.factory(require('./inline-tag-defs/link')) -.factory(require('dgeni-packages/ngdoc/services/getAliases')) -.factory(require('dgeni-packages/ngdoc/services/getDocFromAlias')) -.factory(require('./services/getLinkInfo')) - -.config(function(inlineTagProcessor, linkInlineTagDef) { - inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef); -}); diff --git a/docs/links-package/inline-tag-defs/link.js b/docs/links-package/inline-tag-defs/link.js deleted file mode 100644 index 89272c63ca..0000000000 --- a/docs/links-package/inline-tag-defs/link.js +++ /dev/null @@ -1,33 +0,0 @@ -var INLINE_LINK = /(\S+)(?:\s+([\s\S]+))?/; - -/** - * @dgService linkInlineTagDef - * @description - * Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors - * @kind function - * @param {Object} url The url to match - * @param {Function} docs error message - * @return {String} The html link information - * - * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc - */ -module.exports = function linkInlineTagDef(getLinkInfo, createDocMessage, log) { - return { - name: 'link', - description: 'Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors', - handler: function(doc, tagName, tagDescription) { - - // Parse out the uri and title - return tagDescription.replace(INLINE_LINK, function(match, uri, title) { - - var linkInfo = getLinkInfo(uri, title, doc); - - if ( !linkInfo.valid ) { - log.warn(createDocMessage(linkInfo.error, doc)); - } - - return "" + linkInfo.title + ""; - }); - } - }; -}; \ No newline at end of file diff --git a/docs/links-package/services/getLinkInfo.js b/docs/links-package/services/getLinkInfo.js deleted file mode 100644 index 787ff04338..0000000000 --- a/docs/links-package/services/getLinkInfo.js +++ /dev/null @@ -1,72 +0,0 @@ -var _ = require('lodash'); -var path = require('canonical-path'); - -/** - * @dgService getLinkInfo - * @description - * Get link information to a document that matches the given url - * @kind function - * @param {String} url The url to match - * @param {String} title An optional title to return in the link information - * @return {Object} The link information - * - * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc - */ -module.exports = function getLinkInfo(getDocFromAlias, encodeCodeBlock, log) { - - return function getLinkInfoImpl(url, title, currentDoc) { - var linkInfo = { - url: url, - type: 'url', - valid: true, - title: title || url - }; - - if ( !url ) { - throw new Error('Invalid url'); - } - - var docs = getDocFromAlias(url, currentDoc); - - if ( !getLinkInfoImpl.useFirstAmbiguousLink && docs.length > 1 ) { - - linkInfo.valid = false; - linkInfo.errorType = 'ambiguous'; - linkInfo.error = 'Ambiguous link: "' + url + '".\n' + - docs.reduce(function(msg, doc) { return msg + '\n "' + doc.id + '" ('+ doc.docType + ') : (' + doc.path + ' / ' + doc.fileInfo.relativePath + ')'; }, 'Matching docs: '); - - } else if ( docs.length >= 1 ) { - - linkInfo.url = docs[0].path; - linkInfo.title = title || encodeCodeBlock(docs[0].name, true); - linkInfo.type = 'doc'; - - if ( getLinkInfoImpl.relativeLinks && currentDoc && currentDoc.path ) { - var currentFolder = path.dirname(currentDoc.path); - var docFolder = path.dirname(linkInfo.url); - var relativeFolder = path.relative(path.join('/', currentFolder), path.join('/', docFolder)); - linkInfo.url = path.join(relativeFolder, path.basename(linkInfo.url)); - log.debug(currentDoc.path, docs[0].path, linkInfo.url); - } - - } else if ( url.indexOf('#') > 0 ) { - var pathAndHash = url.split('#'); - linkInfo = getLinkInfoImpl(pathAndHash[0], title, currentDoc); - linkInfo.url = linkInfo.url + '#' + pathAndHash[1]; - return linkInfo; - - } else if ( url.indexOf('/') === -1 && url.indexOf('#') !== 0 ) { - - linkInfo.valid = false; - linkInfo.errorType = 'missing'; - linkInfo.error = 'Invalid link (does not match any doc): "' + url + '"'; - - } else { - - linkInfo.title = title || (( url.indexOf('#') === 0 ) ? url.substring(1) : path.basename(url, '.html')); - - } - - return linkInfo; - }; -}; \ No newline at end of file diff --git a/docs/public-docs-package/index.js b/docs/public-docs-package/index.js deleted file mode 100644 index ee8823d845..0000000000 --- a/docs/public-docs-package/index.js +++ /dev/null @@ -1,24 +0,0 @@ -var Package = require('dgeni').Package; -var basePackage = require('../docs-package'); - -module.exports = new Package('angular-v2-public-docs', [basePackage]) - -.config(function(readTypeScriptModules) { - readTypeScriptModules.sourceFiles = [ - 'angular2/lifecycle_hooks.ts', - 'angular2/core.ts', - 'angular2/http.ts', - 'angular2/router.ts', - 'angular2/test.ts' - ]; - readTypeScriptModules.hidePrivateMembers = true; -}) - -.config(function(getLinkInfo) { - getLinkInfo.useFirstAmbiguousLink = false; -}) - -// Configure file writing -.config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = 'dist/public_docs'; -}); diff --git a/gulpfile.js b/gulpfile.js index 430de1c98a..9a80dbed96 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -415,106 +415,8 @@ gulp.task('serve.e2e.dart', ['build.js.cjs'], function(neverDone) { // -------------- -// doc generation +// d.ts generation var Dgeni = require('dgeni'); -var bower = require('bower'); -var webserver = require('gulp-webserver'); - -gulp.task('docs/bower', function() { - var bowerTask = bower.commands.install(undefined, undefined, { cwd: 'docs' }); - bowerTask.on('log', function (result) { - console.log('bower:', result.id, result.data); - }); - bowerTask.on('error', function(error) { - console.log(error); - }); - return bowerTask; -}); - - -function createDocsTasks(options) { - var dgeniPackage = options.package; - var distDocsPath = options.path; - var taskPrefix = options.prefix; - - gulp.task(taskPrefix + '/dgeni', function() { - try { - var dgeni = new Dgeni([require(dgeniPackage)]); - return dgeni.generate(); - } catch(x) { - console.log(x); - console.log(x.stack); - throw x; - } - }); - - gulp.task(taskPrefix + '/assets', ['docs/bower'], function() { - return gulp.src('docs/bower_components/**/*') - .pipe(gulp.dest(distDocsPath + '/lib')); - }); - - gulp.task(taskPrefix + '/app', function() { - return gulp.src('docs/app/**/*') - .pipe(gulp.dest(distDocsPath)); - }); - - gulp.task(taskPrefix, [taskPrefix + '/assets', taskPrefix + '/app', taskPrefix + '/dgeni']); - gulp.task(taskPrefix + '/watch', function() { - return watch('docs/app/**/*', [taskPrefix + '/app']); - }); - - gulp.task(taskPrefix + '/test', function (done) { - runJasmineTests(['docs/**/*.spec.js'], done); - }); - - gulp.task(taskPrefix + '/serve', function() { - gulp.src(distDocsPath + '/') - .pipe(webserver({ - fallback: 'index.html' - })); - }); -} - - -createDocsTasks({ package: './docs/docs-package', path: 'dist/docs', prefix: 'docs'}); -createDocsTasks({ package: './docs/public-docs-package', path: 'dist/public_docs', prefix: 'public_docs'}); - -gulp.task('docs/angular.io', ['build/clean.docs_angular_io'], function() { - try { - var dgeni = new Dgeni([require('./docs/angular.io-package')]); - return dgeni.generate(); - } catch(x) { - console.log(x); - console.log(x.stack); - throw x; - } -}); - - -gulp.task('docs/angular.io/watch', function() { - watch(['modules/angular2/docs/**', 'modules/**/src/**'], ['docs/angular.io', 'docs/angular.io/copy']); -}); - - -gulp.task('docs/angular.io/copy', function(){ - var DOCS_DIRS = ['core', 'http', 'lifecycle_hooks', 'router', 'test']; - var DOCS_DIST = 'dist/angular.io/partials/api/angular2/'; - var DOCS_IO_DIST = '../angular.io/public/docs/js/latest/api/'; - - var fs = require('fs'); - var fse = require('fs-extra'); - - if (!fs.existsSync('../angular.io')) { - throw new Error('docs/angular.io-watch task requires the angular.io repo to be at ' + path.resolve('../angular.io')); - } - - DOCS_DIRS.forEach(function(dir) { - var distIODir = DOCS_IO_DIST + dir; - fse.removeSync(distIODir); - fse.copySync(DOCS_DIST + dir, DOCS_IO_DIST + dir); - }); -}); - gulp.task('docs/typings', [], function() { try { @@ -543,12 +445,12 @@ function runKarma(configFile, done) { } gulp.task('test.js', function(done) { - runSequence('test.unit.tools/ci', 'test.transpiler.unittest', 'docs/test', 'test.unit.js/ci', + runSequence('test.unit.tools/ci', 'test.transpiler.unittest', 'test.unit.js/ci', 'test.unit.cjs/ci', 'test.typings', sequenceComplete(done)); }); gulp.task('test.dart', function(done) { - runSequence('versions.dart', 'test.transpiler.unittest', 'docs/test', 'test.unit.dart/ci', + runSequence('versions.dart', 'test.transpiler.unittest', 'test.unit.dart/ci', sequenceComplete(done)); }); diff --git a/scripts/ci/build_js.sh b/scripts/ci/build_js.sh index 3217d17f73..d64280c6e3 100755 --- a/scripts/ci/build_js.sh +++ b/scripts/ci/build_js.sh @@ -9,4 +9,3 @@ source $SCRIPT_DIR/env_dart.sh cd $SCRIPT_DIR/../.. ./node_modules/.bin/gulp build.js -./node_modules/.bin/gulp docs