Skip to content

Commit

Permalink
docs(typedoc): Setup initial typedoc gen
Browse files Browse the repository at this point in the history
  • Loading branch information
TasoOneAsia committed Jul 6, 2021
1 parent cc7abdf commit 4c3a06c
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/client/cl_logger.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { LogLevelName } from "../types/logger.types";
import { LogLevelName } from "../types";

interface ClientLoggerSettings {
minLevel: LogLevelName;
Expand Down
4 changes: 4 additions & 0 deletions src/client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@
},
"extends": "../../tsconfig.json",
"include": ["./**/*"],
"typedocOptions": {
"entryPoints": ["index.ts"],
"out": "../../docs"
}
}
8 changes: 7 additions & 1 deletion src/server/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@
"compilerOptions": {
"baseUrl": ".",
"lib": ["es2017"],
"types": ["@citizenfx/server", "@types/node"],
"types": ["@citizenfx/server", "@types/node"]
},
"extends": "../../tsconfig.json",
"include": ["./**/*"],
"typedocOptions": {
"entryPoints": [
"index.ts"
],
"out": "../../docs"
}
}
19 changes: 16 additions & 3 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"compilerOptions": {
"outDir": "./lib",
"types": [],
"strict": true,
"module": "commonjs",
"declaration": true,
Expand All @@ -11,8 +10,22 @@
"lib": ["es2017", "DOM"],
"moduleResolution": "node",
"resolveJsonModule": true,
"esModuleInterop": true,
"esModuleInterop": true
},
"include": ["src/**/*"],
"references": [
{
"path": "src/client"
},
{
"path": "src/server"
},
{
"path": "src/misc"
},
{
"path": "src/types"
}
],
"files": [],
"exclude": ["node_modules"]
}
4 changes: 4 additions & 0 deletions typedoc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"entryPoints": ["../src/client/index.ts", "../src/server/index.ts"],
"out": "./"
}

0 comments on commit 4c3a06c

Please sign in to comment.