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 typedoc-specific tsconfig #112

Merged
merged 3 commits into from
Aug 15, 2023
Merged

add typedoc-specific tsconfig #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
549d505
add typedoc-specific tsconfig, unignore docs directory
sethvincent Aug 10, 2023
291052e
Update tsconfig.typedoc.json
sethvincent Aug 10, 2023
c5c0fa3
ignore docs dir
sethvincent Aug 15, 2023
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
6 changes: 3 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ build/Release
node_modules/
jspm_packages/

# typedoc documentation
/docs

# Optional npm cache directory
.npm

Expand All @@ -61,3 +58,6 @@ jspm_packages/
/dist
/intermediate
/generated

# ignore docs directory for now
/docs
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"build:generate": "node scripts/generate.js",
"build:tsc": "tsc",
"build:copy": "cpy 'intermediate/generated/**' 'intermediate/src/**' dist/",
"build:doc": "typedoc --plugin typedoc-plugin-markdown",
"build:doc": "typedoc src/index.ts --tsconfig tsconfig.typedoc.json --plugin typedoc-plugin-markdown",
"prepack": "npm run build",
"test": "tape 'test/**/*.js'"
},
Expand Down
12 changes: 12 additions & 0 deletions tsconfig.typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"files": ["src/index.ts"],
"exclude": [
"node_modules",
"examples",
"generated/proto/options.ts",
"generated/proto/google/protobuf/descriptor.ts",
"test",
"scripts"
]
}
Loading