Skip to content

Commit

Permalink
fix(docs): fix documents generation
Browse files Browse the repository at this point in the history
  • Loading branch information
gridcat committed Dec 28, 2022
1 parent 54d0b24 commit 56f1308
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 17 deletions.
23 changes: 11 additions & 12 deletions package-lock.json

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

3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,14 @@
"jest": "^29.3.1",
"jest-config": "^29.3.1",
"lint-staged": "^13.1.0",
"lodash.camelcase": "^4.3.0",
"nock": "^13.2.9",
"prompt": "^1.3.0",
"replace-in-file": "^6.3.5",
"rimraf": "^3.0.2",
"semantic-release": "^19.0.5",
"ts-jest": "^29.0.3",
"ts-node": "^10.9.1",
"typedoc": "^0.23.22",
"typedoc": "^0.23.23",
"typescript": "^4.9.4"
},
"dependencies": {
Expand Down
3 changes: 2 additions & 1 deletion tools/generate-doc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ rimraf.sync('docs');

// Got no nice documentation how to run it from the code, keep failing
// So I've decided to use easy way
execSync('typedoc --out docs --theme minimal src');
// execSync('npx typedoc --out docs --theme minimal src');
execSync('npx typedoc --tsconfig ./tsconfig.json --out docs --theme default ./src/*');

// Create file for the circleci so circleci will ignore it
mkdirSync('docs/.circleci');
Expand Down
3 changes: 1 addition & 2 deletions tools/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"compilerOptions": {
"target": "es2015",
// "target": "es5",
"target": "es6",
"module": "commonjs",
"declaration": false,
"strict": true,
Expand Down

0 comments on commit 56f1308

Please sign in to comment.