Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove examples-package #7190

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion docs_app/package.json
Expand Up @@ -85,7 +85,6 @@
"css-selector-parser": "^1.3.0",
"dgeni": "^0.4.14",
"dgeni-packages": "^0.30.0",
"entities": "^1.1.1",
"eslint": "^5.16.0",
"eslint-plugin-jasmine": "^2.2.0",
"firebase-tools": "^9.3.0",
Expand Down
1 change: 0 additions & 1 deletion docs_app/tools/transforms/README.md
Expand Up @@ -38,7 +38,6 @@ you are working on.
* angular-api-package
* angular-content-package
* content-package
* examples-package
* links-package
* post-process-package
* remark-package
Expand Down
5 changes: 2 additions & 3 deletions docs_app/tools/transforms/angular-api-package/index.js
Expand Up @@ -12,6 +12,7 @@ const typeScriptPackage = require('dgeni-packages/typescript');
const { API_SOURCE_PATH, API_TEMPLATES_PATH, MARBLE_IMAGES_PATH, MARBLE_IMAGES_WEB_PATH,
requireFolder } = require('../config');

// prettier-ignore
module.exports = new Package('angular-api', [basePackage, typeScriptPackage])

// Register the processors
Expand Down Expand Up @@ -55,7 +56,7 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
})

// Where do we get the source files?
.config(function(readTypeScriptModules, readFilesProcessor, collectExamples, tsParser) {
.config(function(readTypeScriptModules, readFilesProcessor, tsParser) {

// Tell TypeScript how to load modules that start with `@angular`
tsParser.options.paths = { '@angular/*': [API_SOURCE_PATH + '/*'] };
Expand Down Expand Up @@ -84,7 +85,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
fileReader: 'exampleFileReader'
}
];
collectExamples.exampleFolders.push('examples');
})

// Configure jsdoc-style tag parsing
Expand All @@ -96,7 +96,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])

// Additional jsdoc config (for RxJS source)
.config(function(parseTagsProcessor) {
parseTagsProcessor.tagDefinitions.push({ name: 'example', aliases: ['examples'], multi: true, docProperty: 'examples' });
parseTagsProcessor.tagDefinitions.push({ name: 'owner' });
parseTagsProcessor.tagDefinitions.push({ name: 'static' });
parseTagsProcessor.tagDefinitions.push({ name: 'nocollapse' });
Expand Down
13 changes: 3 additions & 10 deletions docs_app/tools/transforms/angular-base-package/index.js
Expand Up @@ -11,18 +11,17 @@ const Package = require('dgeni').Package;
const jsdocPackage = require('dgeni-packages/jsdoc');
const nunjucksPackage = require('dgeni-packages/nunjucks');
const linksPackage = require('../links-package');
const examplesPackage = require('../examples-package');
const targetPackage = require('../target-package');
const remarkPackage = require('../remark-package');
const postProcessPackage = require('dgeni-packages/post-process-html');

const { PROJECT_ROOT, CONTENTS_PATH, OUTPUT_PATH, DOCS_OUTPUT_PATH, TEMPLATES_PATH, AIO_PATH, requireFolder } = require('../config');

// prettier-ignore
module.exports = new Package('angular-base', [
jsdocPackage,
nunjucksPackage,
linksPackage,
examplesPackage,
targetPackage,
remarkPackage,
postProcessPackage,
Expand Down Expand Up @@ -60,14 +59,12 @@ module.exports = new Package('angular-base', [
})

// Where do we get the source files?
.config(function (readFilesProcessor, collectExamples, generateKeywordsProcessor, jsonFileReader) {
.config(function (readFilesProcessor, generateKeywordsProcessor, jsonFileReader) {
readFilesProcessor.fileReaders.push(jsonFileReader);
readFilesProcessor.basePath = PROJECT_ROOT;
readFilesProcessor.sourceFiles = [];
collectExamples.exampleFolders = [];

generateKeywordsProcessor.ignoreWordsFile = path.resolve(__dirname, 'ignore.words');
generateKeywordsProcessor.docTypesToIgnore = ['example-region'];
generateKeywordsProcessor.propertiesToIgnore = ['renderedContent'];
})

Expand Down Expand Up @@ -125,12 +122,8 @@ module.exports = new Package('angular-base', [
getLinkInfo.useFirstAmbiguousLink = false;
})

.config(function (computePathsProcessor, generateKeywordsProcessor) {
.config(function (generateKeywordsProcessor) {
generateKeywordsProcessor.outputFolder = 'app';

// Replace any path templates inherited from other packages
// (we want full and transparent control)
computePathsProcessor.pathTemplates = [{ docTypes: ['example-region'], getOutputPath: function () {} }];
})

.config(function (postProcessHtml, addImageDimensions, autoLinkCode, filterPipes, filterAmbiguousDirectiveAliases, filterFromInImports, filterNeverAsGeneric) {
Expand Down

This file was deleted.

7 changes: 2 additions & 5 deletions docs_app/tools/transforms/angular.io-package/index.js
Expand Up @@ -13,6 +13,7 @@ const { extname, resolve } = require('canonical-path');
const { existsSync } = require('fs');
const { SRC_PATH } = require('../config');

// prettier-ignore
module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPackage])

// This processor relies upon the versionInfo. See below...
Expand All @@ -27,7 +28,7 @@ module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPacka
renderDocsProcessor.extraData.versionInfo = versionInfo;
})

.config(function(checkAnchorLinksProcessor, linkInlineTagDef, renderExamples) {
.config(function(checkAnchorLinksProcessor, linkInlineTagDef) {

// Fail the processing if there is an invalid link
linkInlineTagDef.failOnBadLink = false;
Expand All @@ -50,10 +51,6 @@ module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPacka
});
checkAnchorLinksProcessor.pathVariants = ['', '/', '.html', '/index.html', '#top-of-page'];
checkAnchorLinksProcessor.errorOnUnmatchedLinks = false;

// Make sure we fail if the examples are not right
renderExamples.ignoreBrokenExamples = false;

})

.config(function(renderLinkInfo, postProcessHtml) {
Expand Down

This file was deleted.

28 changes: 0 additions & 28 deletions docs_app/tools/transforms/examples-package/index.js

This file was deleted.

This file was deleted.

This file was deleted.