Skip to content

Commit 81f5a98

Browse files
anweshananweshan
authored
Adding typedoc documentation (watson-developer-cloud#596)
1 parent 54e1e7c commit 81f5a98

38 files changed

+4973
-2725
lines changed

‎.travis.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ node_js:
44
- 4
55
- 6
66
- stable
7-
script:
8-
- tsc # use the tsconfig.json to transpile specified service-files
9-
- npm test
107
before_install:
118
- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_d4f181ef7c79_key
129
-iv $encrypted_d4f181ef7c79_iv -in auth.js.enc -out test/resources/auth.js -d ||
1310
true'
14-
- npm install -g typescript
11+
- npm install -g typescript
12+
script:
13+
- tsc # use the tsconfig.json to transpile specified service-files
14+
- npm test
15+
- sh scripts/typedoc/generate_typedoc.sh
16+
after_success:
17+
- scripts/jsdoc/publish.sh

‎package-lock.json

Lines changed: 3235 additions & 2718 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
"prettier": "~1.9.1",
6464
"sinon": "~4.1.2",
6565
"typescript": "~2.6.2",
66+
"typedoc": "^0.9.0",
6667
"uglify-es": "~3.2.1",
6768
"watchify": "~3.9.0",
6869
"wav": "~1.0.0",

‎scripts/jsdoc/publish.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ if [ "$TRAVIS_REPO_SLUG" == "watson-developer-cloud/node-sdk" ] && [ "$TRAVIS_PU
1717
# on tagged builds, $TRAVIS_BRANCH is the tag (e.g. v1.2.3), otherwise it's the branch name (e.g. master)
1818
rm -rf $TRAVIS_BRANCH
1919
mkdir $TRAVIS_BRANCH
20-
cp -Rf ../doc/watson-developer-cloud/*/* ./$TRAVIS_BRANCH
20+
cp -Rf ../doc/. ./$TRAVIS_BRANCH
2121

2222
# update the latest/ symlink
2323
# on tagged builds, $TRAVIS_TAG is set to the tag, but it's blank on regular builds, unlike $TRAVIS_BRANCH
@@ -42,12 +42,12 @@ if [ "$TRAVIS_REPO_SLUG" == "watson-developer-cloud/node-sdk" ] && [ "$TRAVIS_PU
4242

4343
# add all changes to git, including deleted files
4444
git add -f -A .
45-
git commit -m "JSDdoc for $TRAVIS_BRANCH ($TRAVIS_COMMIT)"
45+
git commit -m "Doc for $TRAVIS_BRANCH ($TRAVIS_COMMIT)"
4646
git push -fq origin gh-pages > /dev/null
4747

4848
popd
4949

50-
echo -e "Published JSDoc for $TRAVIS_BRANCH to gh-pages.\n"
50+
echo -e "Published Doc for $TRAVIS_BRANCH to gh-pages.\n"
5151

5252
else
5353

‎scripts/typedoc/generate_typedoc.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
./node_modules/.bin/typedoc --mode file --theme ./scripts/typedoc/theme --excludeExternals \
2+
--out ./doc ./authorization/v1.ts ./conversation/v1-generated.ts \
3+
./discovery/v1-generated.ts ./dialog/v1.ts ./language-translator/v2-generated.ts \
4+
./natural-language-classifier/v1-generated.ts ./natural-language-understanding/v1.ts \
5+
./personality-insights/v3-generated.ts ./personality-insights/v2.ts \
6+
./speech-to-text/v1-generated.ts ./text-to-speech/v1-generated.ts \
7+
./tone-analyzer/v3-generated.ts ./visual-recognition/v3-generated.ts \
8+
./lib/recognize-stream.ts --target "ES5"
9+

‎scripts/typedoc/theme/assets/css/main.css

Lines changed: 865 additions & 0 deletions
Large diffs are not rendered by default.

‎scripts/typedoc/theme/assets/css/main.css.map

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎scripts/typedoc/theme/assets/images/icons.png

9.26 KB
Loading

‎scripts/typedoc/theme/assets/images/[email protected]

27.1 KB
Loading

‎scripts/typedoc/theme/assets/images/widgets.png

480 Bytes
Loading

‎scripts/typedoc/theme/assets/images/[email protected]

855 Bytes
Loading

‎scripts/typedoc/theme/assets/js/main.js

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎scripts/typedoc/theme/layouts/default.hbs

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
10+
<link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
11+
</head>
12+
<body>
13+
14+
{{> header}}
15+
16+
<div class="container container-main">
17+
<div class="row">
18+
<div class="col-8 col-content">
19+
{{{contents}}}
20+
</div>
21+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22+
<nav class="tsd-navigation primary">
23+
<ul>
24+
{{#each navigation.children}}
25+
{{> navigation}}
26+
{{/each}}
27+
</ul>
28+
</nav>
29+
30+
<nav class="tsd-navigation secondary menu-sticky">
31+
<ul class="before-current">
32+
{{#each toc.children}}
33+
{{> toc.root}}
34+
{{/each}}
35+
</ul>
36+
</nav>
37+
</div>
38+
</div>
39+
</div>
40+
41+
{{> footer}}
42+
43+
<div class="overlay"></div>
44+
<script src="{{relativeURL "assets/js/main.js"}}"></script>
45+
<script>if (location.protocol == 'file:') document.write('<script src="{{relativeURL "assets/js/search.js"}}"><' + '/script>');</script>
46+
47+
{{> analytics}}
48+
49+
</body>
50+
</html>

‎scripts/typedoc/theme/partials/analytics.hbs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{{#if settings.gaID}}
2+
<script>
3+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
7+
8+
ga('create', '{{settings.gaID}}', '{{settings.gaSite}}');
9+
ga('send', 'pageview');
10+
</script>
11+
{{/if}}

‎scripts/typedoc/theme/partials/breadcrumb.hbs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{{#if parent}}
2+
{{#with parent}}{{> breadcrumb}}{{/with}}
3+
<li>
4+
{{#if url}}
5+
<a href="{{relativeURL url}}">{{name}}</a>
6+
{{else}}
7+
<span>{{name}}</span>
8+
{{/if}}
9+
</li>
10+
{{else}}
11+
{{#if url}}
12+
<li>
13+
<a href="{{relativeURL url}}">Globals</a>
14+
</li>
15+
{{/if}}
16+
{{/if}}

‎scripts/typedoc/theme/partials/comment.hbs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{{#with comment}}
2+
{{#if hasVisibleComponent}}
3+
<div class="tsd-comment tsd-typography">
4+
{{#if shortText}}
5+
<div class="lead">
6+
{{#markdown}}{{{shortText}}}{{/markdown}}
7+
</div>
8+
{{/if}}
9+
{{#if text}}
10+
{{#markdown}}{{{text}}}{{/markdown}}
11+
{{/if}}
12+
{{#if tags}}
13+
<dl class="tsd-comment-tags">
14+
{{#each tags}}
15+
<dt>{{tagName}}</dt>
16+
<dd>{{#markdown}}{{{text}}}{{/markdown}}</dd>
17+
{{/each}}
18+
</dl>
19+
{{/if}}
20+
</div>
21+
{{/if}}
22+
{{/with}}

‎scripts/typedoc/theme/partials/footer.hbs

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
2+
<footer{{#unless settings.hideGenerator}} class="with-border-bottom"{{/unless}}>
3+
<div class="container">
4+
<h2>Legend</h2>
5+
<div class="tsd-legend-group">
6+
<ul class="tsd-legend">
7+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
8+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
9+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
10+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
11+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
12+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
13+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
14+
</ul>
15+
<ul class="tsd-legend">
16+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
17+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
18+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
19+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
20+
</ul>
21+
<ul class="tsd-legend">
22+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
23+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
24+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
25+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
26+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
27+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
28+
</ul>
29+
<ul class="tsd-legend">
30+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
31+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
32+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
33+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
34+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
35+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
36+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
37+
</ul>
38+
<ul class="tsd-legend">
39+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
40+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
41+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
42+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
43+
</ul>
44+
<ul class="tsd-legend">
45+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
46+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
47+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
48+
</ul>
49+
<ul class="tsd-legend">
50+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
51+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
52+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
53+
</ul>
54+
<ul class="tsd-legend">
55+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
56+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
57+
</ul>
58+
</div>
59+
</div>
60+
</footer>
61+
62+
{{#unless settings.hideGenerator}}
63+
<div class="container tsd-generator">
64+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
65+
</div>
66+
{{/unless}}

‎scripts/typedoc/theme/partials/header.hbs

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<header>
2+
<div class="tsd-page-toolbar">
3+
<div class="container">
4+
<div class="table-wrap">
5+
<div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.js"}}" data-base="{{relativeURL "./"}}">
6+
<div class="field">
7+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
8+
<input id="tsd-search-field" type="text" />
9+
</div>
10+
11+
<ul class="results">
12+
<li class="state loading">Preparing search index...</li>
13+
<li class="state failure">The search index is not available</li>
14+
</ul>
15+
16+
<a href="{{relativeURL "index.html"}}" class="title">{{project.name}}</a>
17+
</div>
18+
19+
<div class="table-cell" id="tsd-widgets">
20+
<div id="tsd-filter">
21+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
22+
<div class="tsd-filter-group">
23+
<div class="tsd-select" id="tsd-filter-visibility">
24+
<span class="tsd-select-label">All</span>
25+
<ul class="tsd-select-list">
26+
<li data-value="public">Public</li>
27+
<li data-value="protected">Public/Protected</li>
28+
<li data-value="private" class="selected">All</li>
29+
</ul>
30+
</div>
31+
32+
<input type="checkbox" id="tsd-filter-inherited" checked />
33+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
34+
35+
{{#unless settings.excludeExternals}}
36+
<input type="checkbox" id="tsd-filter-externals" checked />
37+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
38+
{{/unless}}
39+
40+
{{#unless settings.excludeNotExported}}
41+
<input type="checkbox" id="tsd-filter-only-exported" />
42+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
43+
{{/unless}}
44+
</div>
45+
</div>
46+
47+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48+
</div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="tsd-page-title">
53+
<div class="container">
54+
<ul class="tsd-breadcrumb">
55+
{{#with model}}{{> breadcrumb}}{{/with}}
56+
</ul>
57+
<h1>{{#compact}}
58+
{{model.kindString}}&nbsp;
59+
{{model.name}}
60+
{{#if model.typeParameters}}
61+
&lt;
62+
{{#each model.typeParameters}}
63+
{{#if @index}},&nbsp;{{/if}}
64+
{{name}}
65+
{{/each}}
66+
&gt;
67+
{{/if}}
68+
{{/compact}}</h1>
69+
</div>
70+
</div>
71+
</header>

‎scripts/typedoc/theme/partials/hierarchy.hbs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<ul class="tsd-hierarchy">
2+
{{#each types}}
3+
<li>
4+
{{#if ../isTarget}}
5+
<span class="target">{{this}}</span>
6+
{{else}}
7+
{{> type}}
8+
{{/if}}
9+
10+
{{#if @last}}
11+
{{#with ../next}}
12+
{{> hierarchy}}
13+
{{/with}}
14+
{{/if}}
15+
</li>
16+
{{/each}}
17+
</ul>

‎scripts/typedoc/theme/partials/index.hbs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{{#if groups}}
2+
<section class="tsd-panel-group tsd-index-group">
3+
<h2>Index</h2>
4+
<section class="tsd-panel tsd-index-panel">
5+
<div class="tsd-index-content">
6+
{{#each groups}}
7+
<section class="tsd-index-section {{cssClasses}}">
8+
<h3>{{title}}</h3>
9+
<ul class="tsd-index-list">
10+
{{#each children}}
11+
<li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
12+
{{/each}}
13+
</ul>
14+
</section>
15+
{{/each}}
16+
</div>
17+
</section>
18+
</section>
19+
{{/if}}

‎scripts/typedoc/theme/partials/member.declaration.hbs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<div class="tsd-signature tsd-kind-icon">{{#compact}}
2+
{{{wbr name}}}<span class="tsd-signature-symbol">{{#if isOptional}}?{{/if}}:</span>&nbsp;{{#with type}}{{>type}}{{/with}}
3+
{{#if defaultValue}}
4+
<span class="tsd-signature-symbol">
5+
&nbsp;=&nbsp;
6+
{{defaultValue}}
7+
</span>
8+
{{/if}}
9+
{{/compact}}</div>
10+
11+
{{> member.sources}}
12+
13+
{{> comment}}
14+
15+
{{#if type.declaration}}
16+
<div class="tsd-type-declaration">
17+
<h4>Type declaration</h4>
18+
{{#with type.declaration}}
19+
{{> parameter}}
20+
{{/with}}
21+
</div>
22+
{{/if}}

0 commit comments

Comments
 (0)