Skip to content

Added Script to generate typedoc documentation #10

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added Script to generate typedoc documentation #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,6 @@ docs/public/

# Code editors or IDEs
.vscode/

# Typedoc generated files
modules/**/generated/
2 changes: 2 additions & 0 deletions modules/ROOT/pages/common/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@

* link:{{navprefix}}/runtime-filters[Runtime filters]

include::generated/typedoc/VisualEmbedSdkNavLinks.adoc[]

* Additional resources
** link:{{navprefix}}/faqs[FAQs]
** link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors]
Expand Down
7 changes: 5 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
"description": "ThoughtSpot Embed SDK Docs",
"scripts": {
"start": "gatsby develop",
"build:gatsby": "npm run clean:gatsby && gatsby build --prefix-paths",
"build:gatsby": "npm run generate-typedoc && npm run clean:gatsby && gatsby build --prefix-paths",
"build:gatsby:noprefix": "npm run clean:gatsby && gatsby build",
"serve:gatsby": "gatsby serve",
"clean:gatsby": "gatsby clean",
"build-and-publish": "npm run build:gatsby && npm run publish",
"docs-cmd": "node scripts/gatsby-commands.js",
"test": "jest -c jest.config.docs.js",
"publish-dev": "npm publish --tag dev",
"publish-prod": "npm publish --tag latest"
"publish-prod": "npm publish --tag latest",
"generate-typedoc": "ts-node-esm scripts/Converter/index.ts",
"generate-typedoc:debug": "node --inspect -r ts-node/register scripts/Converter/index.ts"
},
"peerDependencies": {
"react": "> 16.8.0",
Expand Down Expand Up @@ -79,6 +81,7 @@
"react-test-renderer": "^17.0.2",
"react-use-flexsearch": "^0.1.1",
"ts-jest": "^26.5.5",
"ts-node": "^10.9.1",
"typedoc": "0.21.6",
"typescript": "^4.9.4",
"url-search-params-polyfill": "^8.1.0",
Expand Down
Loading