iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

output an audit file to keep track of documentation progress on API

This commit is contained in:
Eric Jimenez 2016-07-28 10:29:03 -04:00 committed by Naomi Black
parent 1e194b1960
commit cece720f47
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
tools/api-builder/angular.io-package/index.js
View File

@ -136,6 +136,12 @@ module.exports = new Package('angular.io', [basePackage, targetPackage, cheatshe
outputPathTemplate: '${path}' outputPathTemplate: '${path}'
}); });
computePathsProcessor.pathTemplates.push({
docTypes: ['api-list-data'],
pathTemplate: 'api-list-audit.json',
outputPathTemplate: '${path}'
});
computePathsProcessor.pathTemplates.push({ computePathsProcessor.pathTemplates.push({
docTypes: ['cheatsheet-data'], docTypes: ['cheatsheet-data'],
pathTemplate: '../guide/cheatsheet.json', pathTemplate: '../guide/cheatsheet.json',

15
tools/api-builder/angular.io-package/templates/api-list-audit.template.html Normal file
View File

@ -0,0 +1,15 @@
[{% for module, items in doc.data %}
{% for item in items %}
{
"title": "{$ item.title $}",
"path": "{$ item.exportDoc.path $}",
"docType": "{$ item.docType $}",
"stability": "{$ item.stability $}",
"secure": "{$ item.security $}",
"howToUse": "{$ item.howToUse $}",
"whatItDoes": {% if item.whatItDoes %}"Exists"{% else %}"Not Done"{% endif %},
"barrel" : "{$ module | replace("/index", "") $}"
}{% if not loop.last %},{% endif %}
{% endfor %}
{% endfor %}
]