[web][doc] Update github-pages workflow and others

To keep the autogenerated content accessible from doc/index.html.
openSUSE · Jan 8, 2024 · a829174 · a829174
1 parent a02f833
commit a829174
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -51,8 +51,8 @@ jobs:
       - name: Install NPM packages
         run: cd web && npm ci
 
-      - name: Build the JSDoc documentation
-        run: cd web && npm run jsdoc && mv jsdoc.out ../doc/dist/jsdoc
+      - name: Build Web UI documentation
+        run: cd web && npm run typedoc && mv typedoc.out/ ../doc/dist/web-ui
 
       - name: Setup Pages
         uses: actions/configure-pages@v3

diff --git a/doc/index.html b/doc/index.html
@@ -8,7 +8,13 @@
 <body>
   <ul>
     <li><a href="dbus/">D-Bus API</a></li>
-    <li><a href="jsdoc/">Web Fronted Documentation</a></li>
+    <li>
+        Web UI
+        <ul>
+          <li><a href="web-ui/client/">Client</a></li>
+          <li><a href="web-ui/components/">Components</a></li>
+        </ul>
+    </li>
   </ul>
 </body>
 

diff --git a/web/.gitignore b/web/.gitignore
@@ -16,5 +16,5 @@ test/images/
 POTFILES*
 tmp/
 /po/LINGUAS
-/jsdoc.out/
+/typedoc.out/
 /docs/
diff --git a/web/package.json b/web/package.json
@@ -19,8 +19,8 @@
     "stylelint:fix": "stylelint --fix 'src/**/*.{css,scss}'",
     "check-types": "tsc --skipLibCheck",
     "typedoc": "npm run typedoc:client && npm run typedoc:components",
-    "typedoc:client": "npx typedoc --entryPoints src/client --out jsdoc.out/client",
-    "typedoc:components": "npx typedoc --entryPoints src/components --out jsdoc.out/components",
+    "typedoc:client": "npx typedoc --entryPoints src/client --out typedoc.out/client",
+    "typedoc:components": "npx typedoc --entryPoints src/components --out typedoc.out/components",
     "test": "jest"
   },
   "engines": {