From 888f9ff8d85221c1ba6ae5f88f725178d3cd70ab Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Fri, 13 Nov 2015 14:08:25 +0000 Subject: [PATCH] api-builder: move templates into angular.io package --- .../templates/const.template.html | 1 + .../templates/interface.template.html | 1 + .../templates/lib/githubLinks.html | 0 .../templates/overview-dump.template.html | 0 .../templates/type-alias.template.html | 0 tools/api-builder/docs-package/index.js | 3 -- .../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 - .../docs-package/templates/lib/paramList.html | 7 --- .../docs-package/templates/var.template.html | 10 ----- 16 files changed, 2 insertions(+), 95 deletions(-) create mode 100644 tools/api-builder/angular.io-package/templates/const.template.html create mode 100644 tools/api-builder/angular.io-package/templates/interface.template.html rename tools/api-builder/{docs-package => angular.io-package}/templates/lib/githubLinks.html (100%) rename tools/api-builder/{docs-package => angular.io-package}/templates/overview-dump.template.html (100%) rename tools/api-builder/{docs-package => angular.io-package}/templates/type-alias.template.html (100%) delete mode 100644 tools/api-builder/docs-package/templates/class.template.html delete mode 100644 tools/api-builder/docs-package/templates/common.template.html delete mode 100644 tools/api-builder/docs-package/templates/const.template.html delete mode 100644 tools/api-builder/docs-package/templates/data-module.template.js delete mode 100644 tools/api-builder/docs-package/templates/function.template.html delete mode 100644 tools/api-builder/docs-package/templates/guide.template.html delete mode 100644 tools/api-builder/docs-package/templates/interface.template.html delete mode 100644 tools/api-builder/docs-package/templates/layout/base.template.html delete mode 100644 tools/api-builder/docs-package/templates/lib/paramList.html delete mode 100644 tools/api-builder/docs-package/templates/var.template.html diff --git a/tools/api-builder/angular.io-package/templates/const.template.html b/tools/api-builder/angular.io-package/templates/const.template.html new file mode 100644 index 0000000000..a208c7ca4f --- /dev/null +++ b/tools/api-builder/angular.io-package/templates/const.template.html @@ -0,0 +1 @@ +{% extends 'var.template.html' -%} \ No newline at end of file diff --git a/tools/api-builder/angular.io-package/templates/interface.template.html b/tools/api-builder/angular.io-package/templates/interface.template.html new file mode 100644 index 0000000000..9c59159b29 --- /dev/null +++ b/tools/api-builder/angular.io-package/templates/interface.template.html @@ -0,0 +1 @@ +{% extends 'class.template.html' -%} \ No newline at end of file diff --git a/tools/api-builder/docs-package/templates/lib/githubLinks.html b/tools/api-builder/angular.io-package/templates/lib/githubLinks.html similarity index 100% rename from tools/api-builder/docs-package/templates/lib/githubLinks.html rename to tools/api-builder/angular.io-package/templates/lib/githubLinks.html diff --git a/tools/api-builder/docs-package/templates/overview-dump.template.html b/tools/api-builder/angular.io-package/templates/overview-dump.template.html similarity index 100% rename from tools/api-builder/docs-package/templates/overview-dump.template.html rename to tools/api-builder/angular.io-package/templates/overview-dump.template.html diff --git a/tools/api-builder/docs-package/templates/type-alias.template.html b/tools/api-builder/angular.io-package/templates/type-alias.template.html similarity index 100% rename from tools/api-builder/docs-package/templates/type-alias.template.html rename to tools/api-builder/angular.io-package/templates/type-alias.template.html diff --git a/tools/api-builder/docs-package/index.js b/tools/api-builder/docs-package/index.js index f219f15647..63d3272cd8 100644 --- a/tools/api-builder/docs-package/index.js +++ b/tools/api-builder/docs-package/index.js @@ -85,9 +85,6 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, variableEnd: '$}' }; - templateFinder.templateFolders - .unshift(path.resolve(__dirname, 'templates')); - templateFinder.templatePatterns = [ '${ doc.template }', '${ doc.id }.${ doc.docType }.template.html', diff --git a/tools/api-builder/docs-package/templates/class.template.html b/tools/api-builder/docs-package/templates/class.template.html deleted file mode 100644 index f0fc6b2801..0000000000 --- a/tools/api-builder/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.internal %} -
-

- {$ 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/tools/api-builder/docs-package/templates/common.template.html b/tools/api-builder/docs-package/templates/common.template.html deleted file mode 100644 index dc10750a80..0000000000 --- a/tools/api-builder/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/tools/api-builder/docs-package/templates/const.template.html b/tools/api-builder/docs-package/templates/const.template.html deleted file mode 100644 index 8b813c7d8e..0000000000 --- a/tools/api-builder/docs-package/templates/const.template.html +++ /dev/null @@ -1 +0,0 @@ -{% extends 'var.template.html' -%} diff --git a/tools/api-builder/docs-package/templates/data-module.template.js b/tools/api-builder/docs-package/templates/data-module.template.js deleted file mode 100644 index 498cdad8cf..0000000000 --- a/tools/api-builder/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/tools/api-builder/docs-package/templates/function.template.html b/tools/api-builder/docs-package/templates/function.template.html deleted file mode 100644 index 4e6d5441f6..0000000000 --- a/tools/api-builder/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/tools/api-builder/docs-package/templates/guide.template.html b/tools/api-builder/docs-package/templates/guide.template.html deleted file mode 100644 index 3ee289dbc8..0000000000 --- a/tools/api-builder/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/tools/api-builder/docs-package/templates/interface.template.html b/tools/api-builder/docs-package/templates/interface.template.html deleted file mode 100644 index 3bde456ceb..0000000000 --- a/tools/api-builder/docs-package/templates/interface.template.html +++ /dev/null @@ -1 +0,0 @@ -{% extends 'class.template.html' -%} diff --git a/tools/api-builder/docs-package/templates/layout/base.template.html b/tools/api-builder/docs-package/templates/layout/base.template.html deleted file mode 100644 index 16a0d9dc96..0000000000 --- a/tools/api-builder/docs-package/templates/layout/base.template.html +++ /dev/null @@ -1 +0,0 @@ -{% block body %}{% endblock %} \ No newline at end of file diff --git a/tools/api-builder/docs-package/templates/lib/paramList.html b/tools/api-builder/docs-package/templates/lib/paramList.html deleted file mode 100644 index 85dccb212b..0000000000 --- a/tools/api-builder/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/tools/api-builder/docs-package/templates/var.template.html b/tools/api-builder/docs-package/templates/var.template.html deleted file mode 100644 index 2d43873595..0000000000 --- a/tools/api-builder/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