Skip to content

docs: complie ts inside js-doc script #486

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

Merged
wprzytula merged 2 commits into from
Jun 19, 2026
Merged

docs: complie ts inside js-doc script #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b312522
docs: complie ts insted js-doc script
dgarcia360 Jun 18, 2026
7a8f61b
docs: rollback edit, keep ts build within js-doc script
dgarcia360 Jun 18, 2026
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
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ clean:
# Generate output commands
.PHONY: jsdoc
jsdoc:
cd .. && ./node_modules/.bin/tsc -p tsconfig.build.json --noEmitOnError false; npm run js-doc
cd .. && npm run js-doc
@echo
@echo "JSDoc build finished. The API docs are in ../public/docs/."

Expand Down
2 changes: 1 addition & 1 deletion docs/_utils/multiversion.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash

cd .. && sphinx-multiversion docs/source docs/_build/dirhtml \
--pre-build 'sh -c "npm install && (./node_modules/.bin/tsc -p tsconfig.build.json --noEmitOnError false || true) && npm run js-doc && python docs/_utils/generate_api_pages.py"'
--pre-build 'sh -c "npm install && npm run js-doc && python docs/_utils/generate_api_pages.py"'
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 @@ -60,7 +60,7 @@
"prettier": "npx prettier \"{lib,examples,test}/**/*.{js,ts}\" --write",
"full-clippy": "cargo clippy --all-targets --all-features -- -D warnings",
"pre-push": "npm run prettier && cargo fmt && npm run full-clippy && napi build --platform && npm run eslint-fix",
"js-doc": "jsdoc ./lib -r -c js-doc-config.js",
"js-doc": "tsc -p tsconfig.build.json --noEmitOnError false; jsdoc ./lib -r -c js-doc-config.js",
"artifacts": "napi artifacts",
"create-npm-dirs": "napi create-npm-dirs",
"build:debug": "napi build --platform",
Expand Down
Loading