Skip to content

Typedocs #77

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
jreyno77 wants to merge 6 commits into
base: feature-remote-execution
Choose a base branch
from
Open

Typedocs #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
95f96a2
Added typedocs dependency and very minimal docs to begin documentation
jreyno77 Aug 29, 2024
4c1d133
add module documentation stubs
jreyno77 Aug 29, 2024
d6fd174
finished up buildParameters docs and added a typedoc config to clean …
jreyno77 Aug 29, 2024
1516684
hotfix specify that remote data can be used in docs.
jreyno77 Aug 29, 2024
cbc3ee3
Added further documentation for connectionManager, executeCql, and no…
jreyno77 Sep 6, 2024
90c91bc
Add doc generation to vscode:prepublish
jreyno77 Sep 6, 2024
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ jars/
bin
.vscode-test
coverage/
docs
173 changes: 173 additions & 0 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.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@
"color-name": "1.1.3"
},
"scripts": {
"vscode:prepublish": "npm run compile",
"vscode:prepublish": "npm run compile && npx typedoc --out docs --entryPointStrategy expand src/",
Copy link
Contributor

@holly-smile holly-smile Sep 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since these docs are for people developing this extension, and thus the ones not using the published version, I don't think it makes sense to run it as part of the pre-publish step. I think it'd be sufficient to have an npm run docs script that generates them.

Suggested change
"vscode:prepublish": "npm run compile && npx typedoc --out docs --entryPointStrategy expand src/",
"vscode:prepublish": "npm run compile",
"docs": "typedoc --out docs --entryPointStrategy expand src/",

(npx isn't needed with npm run, it will automatically scope in any modules with executables!)

If you think otherwise please let me know why!

"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"pretest": "npm run clean && npm run compile && cp -r src/test/suite/resources dist/test/suite/resources",
Expand Down Expand Up @@ -184,6 +184,7 @@
"c8": "^10.1.2",
"prettier": "^3.3.3",
"sinon": "^18.0.0",
"typedoc": "^0.26.6",
"typescript": "^5.3.2"
},
"dependencies": {
Expand Down
Loading