From 6d466e07e9a14647b2330ed7e0590424c2006560 Mon Sep 17 00:00:00 2001 From: Charles Lowell Date: Fri, 20 Sep 2024 22:35:15 -0500 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20typedocs=20for=20Interactor?= =?UTF-8?q?=20API=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit With the migration to Deno and Deploy, we lost the typedocs. This uses typedoc to generate the API docs for the core HTML and MUI interactors. We still haven't solved the problem of how to manage multiple versions at the same time. I have some ideas on how that would work, but until such time, we need to just the the API docs for the latest version up there. --- .github/workflows/website.yaml | 5 ++++- website/package.json | 6 +++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/website.yaml b/.github/workflows/website.yaml index b936fa10..dc047214 100644 --- a/.github/workflows/website.yaml +++ b/.github/workflows/website.yaml @@ -4,9 +4,12 @@ on: push: branches: - main - - www # remove this branch once this is merged to main paths: - website/** + - packages/**/src/** + pull_request: + - branches: + - main jobs: website: diff --git a/website/package.json b/website/package.json index c3b75a4a..c1e102ad 100644 --- a/website/package.json +++ b/website/package.json @@ -4,7 +4,11 @@ "private": true, "scripts": { "start": "docusaurus start", - "build": "docusaurus build --out-dir build/interactors && node sitemap.mjs", + "build": "yarn build:docusaurus && yarn build:sitemap && yarn build:typedocs:html && yarn build:typedocs:mui", + "build:docusaurus": "docusaurus build --out-dir build/interactors", + "build:sitemap": "node sitemap.mjs", + "build:typedocs:html": "cd ../packages/html && npx typedoc --out ../../website/build/interactors/html/api --skipErrorChecking mod.ts", + "build:typedocs:mui": "cd ../packages/material-ui && npx typedoc --out ../../website/build/interactors/mui/api --skipErrorChecking mod.ts", "serve": "docusaurus serve" }, "dependencies": {