From 749cc85bcaa3cda92f84eebb59ba50fe563e5dd5 Mon Sep 17 00:00:00 2001 From: Nicolas Ayral Seydoux Date: Mon, 26 Oct 2026 15:05:37 +0100 Subject: [PATCH] Fix API docs deployment The API docs was publishing to Gihub pages as intended, but the published content was incorrect. The legacy markdown-based API docs were published, instead of the direct output of TypeDoc in HTML. --- .github/dependabot.yml | 10 -------- .gitignore | 4 +--- package-lock.json | 14 ------------ package.json | 9 +++----- tsconfig.json | 31 ------------------------- typedoc.config.mjs | 52 ++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 56 insertions(+), 64 deletions(-) create mode 100644 typedoc.config.mjs diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5babf194..ec7b00e6 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -12,8 +12,6 @@ updates: ignore: - dependency-name: "eslint" update-types: ["version-update:semver-major"] - - dependency-name: "typedoc-plugin-markdown" - update-types: ["version-update:semver-major"] groups: internal-tooling: patterns: @@ -25,14 +23,6 @@ updates: patterns: - "@types/*" - # Enable version updates for the website tooling - - package-ecosystem: "pip" - # Look for `package.json` and `lock` files in the `root` directory - directory: "/docs" - # Check the npm registry for updates every day (weekdays) - schedule: - interval: "weekly" - # Enable version updates for our CI tooling - package-ecosystem: "github-actions" # Look for `package.json` and `lock` files in the `root` directory diff --git a/.gitignore b/.gitignore index afe545e4..d73ec898 100644 --- a/.gitignore +++ b/.gitignore @@ -5,9 +5,7 @@ umd .eslintcache LICENSE_DEPENDENCIES LICENSE_DEPENDENCIES_ALL -docs/api/build/ -docs/api/source/api/ -docs/api/docs-assets/ +docs/api/ docs/dist/ **/.DS_Store **/.env*.local diff --git a/package-lock.json b/package-lock.json index 073fc98c..ec596b2e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,7 +45,6 @@ "ts-jest": "^29.4.15", "ts-node": "^10.9.2", "typedoc": "^0.28.1", - "typedoc-plugin-markdown": "^3.17.1", "typescript": "^6.0.3" }, "engines": { @@ -12740,19 +12739,6 @@ "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" } }, - "node_modules/typedoc-plugin-markdown": { - "version": "3.17.1", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", - "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", - "dev": true, - "license": "MIT", - "dependencies": { - "handlebars": "^4.7.7" - }, - "peerDependencies": { - "typedoc": ">=0.24.0" - } - }, "node_modules/typedoc/node_modules/balanced-match": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", diff --git a/package.json b/package.json index 5c14a68e..061d8894 100644 --- a/package.json +++ b/package.json @@ -8,10 +8,8 @@ ], "scripts": { "build": "rollup --config rollup.config.mjs", - "docs:clean": "cd docs/api; make clean-all", - "docs:install": "cd docs/api; pip install -r requirements.txt", - "docs:build": "typedoc && cd docs/api && make html dist", - "docs:preview": "python3 -m http.server --bind 127.0.0.1 --directory docs/dist", + "docs:build": "typedoc", + "docs:preview": "python3 -m http.server --bind 127.0.0.1 --directory docs/api", "lint": "npm run lint:check", "lint:fix": "npm run lint:eslint -- --fix", "lint:check": "npm run lint:eslint", @@ -26,7 +24,7 @@ "linked data", "turtle" ], - "homepage": "https://docs.inrupt.com/sdk/javascript-sdk", + "homepage": "https://inrupt.github.io/solid-client-vc-js/", "bugs": "https://github.com/inrupt/solid-client-vc-js/issues", "main": "dist/index.js", "module": "dist/index.es.js", @@ -96,7 +94,6 @@ "ts-jest": "^29.4.15", "ts-node": "^10.9.2", "typedoc": "^0.28.1", - "typedoc-plugin-markdown": "^3.17.1", "typescript": "^6.0.3" }, "optionalDependencies": { diff --git a/tsconfig.json b/tsconfig.json index 81b0582d..2b0a2aeb 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -70,37 +70,6 @@ // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ }, - "typedocOptions": { - "hideInPageTOC": true, - "out": "docs/api/source/api", - "entryPoints": [ - // The source files of everything listed under `exports` in our package.json - // (i.e. public API's that should be documented) should be listed here: - "src/issue/issue.ts", - "src/common/common.ts", - "src/lookup/derive.ts", - "src/lookup/query.ts", - "src/revoke/revoke.ts", - "src/verify/verify.ts" - ], - "exclude": [ - "node_modules/**", - "**/*.test.ts", - // Internal helpers: - "**/*.internal.ts", - "**/*.mock.ts", - // Re-exported functions are already documented in their own modules: - "src/index.ts", - // Constants are only used internally: - "src/constants.ts", - // End-to-end tests aren't required in the API docs. - "e2e/**" - ], - "theme": "markdown", - "readme": "none", - "entryDocument": "index.rst", - "plugin": ["typedoc-plugin-markdown"] - }, "include": ["src/**/*.ts"], "exclude": [ "**/node_modules", diff --git a/typedoc.config.mjs b/typedoc.config.mjs new file mode 100644 index 00000000..ca7e05b4 --- /dev/null +++ b/typedoc.config.mjs @@ -0,0 +1,52 @@ +// Copyright Inrupt Inc. +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal in +// the Software without restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the +// Software, and to permit persons to whom the Software is furnished to do so, +// subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +// + +export default { + compilerOptions: { + skipLibCheck: true, + }, + out: "docs/api/", + entryPoints: [ + // The source files of everything listed under `exports` in our package.json + // (i.e. public API's that should be documented) should be listed here: + "src/issue/issue.ts", + "src/common/common.ts", + "src/lookup/derive.ts", + "src/lookup/query.ts", + "src/revoke/revoke.ts", + "src/verify/verify.ts", + ], + exclude: [ + "node_modules/**", + "**/*.test.ts", + // Internal helpers: + "**/*.internal.ts", + "**/*.mock.ts", + // End-to-end tests: + "e2e/**", + // Re-exported functions are already documented in their own modules: + "src/index.ts", + // Constants are only used internally: + "src/constants.ts", + ], + navigation: { + includeCategories: true, + }, +};