diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 93921e93af..8cd4031986 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -5,6 +5,13 @@ on: tags: - 'compressed-token-*' - 'stateless.js-*' + branches: + - 'main' + - 'swen/pub-beta-cov' + paths: + - 'js/stateless.js/src/**' + - 'js/compressed-token/src/**' + workflow_dispatch: {} permissions: @@ -53,6 +60,9 @@ jobs: - name: Build stateless.js run: cd js/stateless.js && pnpm run build + - name: Build compressed-token + run: cd js/compressed-token && pnpm run build + - name: Generate TypeDoc for stateless.js run: npx typedoc --options typedoc.stateless.json diff --git a/typedoc.stateless.json b/typedoc.stateless.json new file mode 100644 index 0000000000..c838aa0f84 --- /dev/null +++ b/typedoc.stateless.json @@ -0,0 +1,53 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "name": "@lightprotocol/stateless.js", + "entryPoints": ["js/stateless.js/src/index.ts"], + "out": "api-docs/stateless.js", + "exclude": [ + "**/node_modules/**", + "**/*.test.ts", + "**/*.spec.ts", + "**/tests/**", + "**/dist/**", + "**/playwright.config.ts" + ], + "excludePrivate": true, + "excludeProtected": false, + "excludeInternal": true, + "skipErrorChecking": true, + "readme": "js/stateless.js/README.md", + "tsconfig": "js/stateless.js/tsconfig.json", + "compilerOptions": { + "skipLibCheck": true + }, + "plugin": [], + "navigation": { + "includeCategories": true, + "includeGroups": true + }, + "categorizeByGroup": true, + "sort": ["source-order"], + "kindSortOrder": [ + "Function", + "Class", + "Interface", + "TypeAlias", + "Variable", + "Enum" + ], + "searchInComments": true, + "visibilityFilters": { + "protected": true, + "private": false, + "inherited": true, + "external": false + }, + "hideGenerator": false, + "includeVersion": true, + "githubPages": true, + "navigationLinks": { + "Other Libraries": "../index.html", + "Documentation": "https://www.zkcompression.com", + "GitHub": "https://github.com/Lightprotocol/light-protocol" + } +}