Skip to content

Commit c381a48

Browse files
chore(doc): added code to generate typescript docs
1 parent ec576d6 commit c381a48

Some content is hidden

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

41 files changed

+1811
-15
lines changed

.travis.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ language: node_js
22

33
sudo: false
44

5-
# node_js:
6-
# - 12
7-
85
before_install:
96
- '[ "${TRAVIS_PULL_REQUEST}" == "false" ] && openssl aes-256-cbc -K $encrypted_cb7060b3a42b_key -iv $encrypted_cb7060b3a42b_iv -in transit-gateway.env.enc -out transit-gateway.env -d || true'
107
- '[ "${TRAVIS_PULL_REQUEST}" == "false" ] && openssl aes-256-cbc -K $encrypted_6de0fb2f002f_key -iv $encrypted_6de0fb2f002f_iv -in directlink.env.enc -out directlink.env -d || true'
@@ -21,7 +18,7 @@ script:
2118
- npm run test-travis || travis_terminate 1
2219
- npm run lint
2320
- npm run check-packages
24-
# - sh scripts/typedoc/generate_typedoc.sh currently in progress
21+
# - sh scripts/typedoc/generate_typedoc.sh
2522

2623
after_success:
2724
- npm run report-coverage

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ibm-networking-services",
3-
"version": "1.0.0",
4-
"description": "IBM Cloud Networking Node.js SDK",
3+
"version": "0.0.1",
4+
"description": "Node.js client library for IBM Cloud Networking Services",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/IBM/networking-node-sdk"
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11

2-
# For each service belonging to your project, add a command like the commented out example below.
3-
# Replace "service-name/v1.ts" with the source directory name and version for the service.
4-
#./node_modules/.bin/typedoc --mode file --theme ./scripts/typedoc/theme --excludeExternals \
5-
# --out ./service-name/v1.ts --target "ES5"
6-
7-
# List the commands for each service here:
2+
# For each service belonging to your project, add a reference to its
3+
# generated source file to the command below.
4+
./node_modules/.bin/typedoc --mode file --theme ./scripts/typedoc/theme --excludeExternals --excludePrivate --excludeProtected \
5+
--out ./doc \
6+
./direct-link/v1.ts \
7+
./transit-gateway/v1.ts \
8+
--target "ES5"

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.
9.26 KB
Loading
27.1 KB
Loading
480 Bytes
Loading
855 Bytes
Loading

0 commit comments

Comments
 (0)