Skip to content

Commit 9fa7d38

Browse files
chore(doc-gen): put typescript stuff into its own package
This means that we can now run just the d.ts file generation by running: ```bash gulp docs/typings ``` In addition the type definition generation was messing with the other docs tasks so separating it also fixes problems there.
1 parent 927454c commit 9fa7d38

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+359
-78
lines changed

docs/angular.io-package/index.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@ module.exports = new Package('angular.io', [basePackage])
2121
writeFilesProcessor.outputFolder = 'dist/angular.io';
2222
})
2323

24-
.config(function(readFilesProcessor, generateNavigationDoc, createOverviewDump, createTypeDefinitionFile) {
24+
.config(function(readFilesProcessor, generateNavigationDoc, createOverviewDump) {
2525
// Clear out unwanted processors
2626
readFilesProcessor.$enabled = false;
2727
generateNavigationDoc.$enabled = false;
2828
createOverviewDump.$enabled = false;
29-
createTypeDefinitionFile.$enabled = false;
3029
})
3130

3231

Lines changed: 5 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,21 @@ require('../../tools/transpiler/index.js').init();
33
var Package = require('dgeni').Package;
44
var jsdocPackage = require('dgeni-packages/jsdoc');
55
var nunjucksPackage = require('dgeni-packages/nunjucks');
6+
var typescriptPackage = require('../typescript-package');
67
var linksPackage = require('../links-package');
78
var gitPackage = require('dgeni-packages/git');
89
var path = require('canonical-path');
910

10-
var PARTIAL_PATH = 'partials';
11-
var MODULES_DOCS_PATH = PARTIAL_PATH + '/modules';
12-
var GUIDES_PATH = PARTIAL_PATH + '/guides';
13-
1411
// Define the dgeni package for generating the docs
15-
module.exports = new Package('angular', [jsdocPackage, nunjucksPackage, linksPackage, gitPackage])
12+
module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, gitPackage])
1613

1714
// Register the services and file readers
18-
.factory(require('./services/modules'))
19-
.factory(require('./services/tsParser'))
20-
.factory(require('./services/tsParser/createCompilerHost'))
21-
.factory(require('./services/tsParser/getFileInfo'))
22-
.factory(require('./services/tsParser/getExportDocType'))
23-
.factory(require('./services/tsParser/getContent'))
2415
.factory(require('./readers/ngdoc'))
2516

26-
.factory('EXPORT_DOC_TYPES', function() {
27-
return [
28-
'class',
29-
'interface',
30-
'function',
31-
'var',
32-
'const',
33-
'enum',
34-
'type-alias'
35-
];
36-
})
37-
38-
3917
// Register the processors
40-
.processor(require('./processors/readTypeScriptModules'))
4118
.processor(require('./processors/generateNavigationDoc'))
4219
.processor(require('./processors/extractTitleFromGuides'))
4320
.processor(require('./processors/createOverviewDump'))
44-
.processor(require('./processors/createTypeDefinitionFile'))
4521

4622

4723
// Configure the log service
@@ -67,7 +43,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage, linksPac
6743
'*/*.@(js|es6|ts)',
6844
'*/src/**/*.@(js|es6|ts)'
6945
];
70-
readTypeScriptModules.basePath = 'modules';
46+
readTypeScriptModules.basePath = path.resolve(readFilesProcessor.basePath, 'modules');
7147
})
7248

7349

@@ -122,13 +98,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage, linksPac
12298

12399

124100
// Configure ids and paths
125-
.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {
126-
127-
computeIdsProcessor.idTemplates.push({
128-
docTypes: ['member'],
129-
idTemplate: '${classDoc.id}.${name}',
130-
getAliases: function(doc) { return [doc.id]; }
131-
});
101+
.config(function(computeIdsProcessor, computePathsProcessor) {
132102

133103
computeIdsProcessor.idTemplates.push({
134104
docTypes: ['guide'],
@@ -144,29 +114,9 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage, linksPac
144114
getAliases: function(doc) { return [doc.id]; }
145115
});
146116

147-
148-
computePathsProcessor.pathTemplates.push({
149-
docTypes: ['module'],
150-
pathTemplate: '/${id}',
151-
outputPathTemplate: MODULES_DOCS_PATH + '/${id}/index.html'
152-
});
153-
154-
computePathsProcessor.pathTemplates.push({
155-
docTypes: EXPORT_DOC_TYPES,
156-
pathTemplate: '${moduleDoc.path}/${name}',
157-
outputPathTemplate: MODULES_DOCS_PATH + '/${path}/index.html'
158-
});
159-
160-
computePathsProcessor.pathTemplates.push({
161-
docTypes: ['member'],
162-
pathTemplate: '${classDoc.path}/${name}',
163-
getOutputPath: function() {} // These docs are not written to their own file, instead they are part of their class doc
164-
});
165-
166-
167117
computePathsProcessor.pathTemplates.push({
168118
docTypes: ['guide'],
169119
pathTemplate: '/${id}',
170-
outputPathTemplate: GUIDES_PATH + '/${id}.html'
120+
outputPathTemplate: 'partials/guides/${id}.html'
171121
});
172122
});
File renamed without changes.

docs/dgeni-package/processors/extractTitleFromGuides.js renamed to docs/docs-package/processors/extractTitleFromGuides.js

File renamed without changes.

docs/dgeni-package/processors/generateNavigationDoc.js renamed to docs/docs-package/processors/generateNavigationDoc.js

File renamed without changes.

0 commit comments

Comments
 (0)