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.

Sign up for GitHub

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

Jump to bottom

Add reference system from TSDOC #103

Closed
wants to merge 2 commits into from
Closed

Add reference system from TSDOC #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a386325
chore: upgrade to ts 3.8
VictorVelarde May 12, 2020
0ccb5d0
feat: first generation of local docs with typedoc (wip)
VictorVelarde May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ dist/
coverage/
.cache/
packages/**/package-lock.json
docs/
secrets.json
23 changes: 23 additions & 0 deletions bundle/typedoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/**
* Configuration for reference, auto-generated from .ts files and their tsdoc comments
*/
module.exports = {
// // // tsconfig: './tsconfig.json',
exclude: ['**/node_modules/**/*.ts', '**/__tests__/**/*', '**/*.types.ts'],
// includes: './packages/**',
excludeExternals: true,
// excludeNotDocumented: true,
excludeNotExported: true,
excludePrivate: true,
// excludeProtected: true,
ignoreCompilerErrors: true,
inputFiles: './packages',
out: './docs/api',
mode: 'file',
theme: 'default',
module: 'es2015',
target: 'es6',
name: 'carto',
plugin: 'none',
listInvalidSymbolLinks: true
};
159 changes: 153 additions & 6 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
"lodash.camelcase": "^4.3.0",
"prettier": "2.0.5",
"source-map-loader": "^0.2.4",
"typedoc": "^0.17.6",
"typedoc-plugin-external-module-name": "3.1.0",
"typedoc-plugin-markdown": "^2.2.17",
"webpack-bundle-analyzer": "^3.7.0"
},
"dependencies": {
Expand All @@ -37,7 +40,7 @@
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"tslint": "^5.20.0",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
},
Expand All @@ -49,6 +52,8 @@
"build": "lerna run build --stream",
"build:watch": "lerna run build:watch --stream --parallel",
"build:debug": "lerna run build:debug --stream",
"build:docs": "rm -rf docs && npm run docs:reference",
"docs:reference": "npx typedoc --options ./bundle/typedoc.js",
"postinstall": "lerna bootstrap --hoist",
"pretest": "lerna run build",
"test": "lerna run test --stream",
Expand Down
2 changes: 1 addition & 1 deletion packages/auth/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"rimraf": "^3.0.0",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"rimraf": "^3.0.0",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/custom-storage/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"rimraf": "^3.0.0",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/maps/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"rimraf": "^3.0.0",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/sql/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"rimraf": "^3.0.0",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-cli": "^3.3.11"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/toolkit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"rollup-plugin-node-polyfills": "^0.2.1",
"ts-jest": "^24.1.0",
"ts-loader": "^6.2.1",
"typescript": "^3.6.3",
"typescript": "^3.8.3",
"webpack": "^4.42.0",
"webpack-bundle-analyzer": "^3.7.0",
"webpack-cli": "^3.3.11"
Expand Down