Fix publish-docs workflow (#669)

paranext · Dec 6, 2023 · 8e6028c · 8e6028c
2 parents 8dbf02b + 4969de3
commit 8e6028c
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 20 deletions.
diff --git a/.github/assets/github-pages-index.html b/.github/assets/github-pages-index.html
@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link
+      rel="stylesheet"
+      href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;700&display=swap"
+    />
+    <title>Platform.Bible API</title>
+    <style>
+      body {
+        font-family: 'Roboto', sans-serif;
+        margin: 40px;
+        padding: 20px;
+        background-color: #fcfcfc;
+        text-align: center;
+      }
+
+      h1 {
+        color: #121212;
+        font-weight: 700;
+      }
+
+      a {
+        display: inline-block;
+        margin: 20px 10px;
+        padding: 10px;
+        background-color: #a70e13;
+        color: #fcfcfc;
+        text-decoration: none;
+        border-radius: 5px;
+        transition: background-color 0.3s ease;
+      }
+
+      a:hover {
+        background-color: #830c14;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Platform.Bible API</h1>
+    <a href="papi-components/index.html">Go to papi-components</a>
+    <a href="papi-dts/index.html">Go to papi-dts</a>
+  </body>
+</html>
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -9,18 +9,14 @@ jobs:
   publish-docs:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node_version: [18.x]
-
     steps:
       - name: Checkout git repo
         uses: actions/checkout@v3
 
       - name: Install Node and NPM
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: 18.x
           cache: npm
 
       - name: Install and build
@@ -29,18 +25,26 @@ jobs:
           npm run build
 
       - name: Build documentation
-        run: | # renaming the folders so that pages links at /{their name} instead of at /docs
-          cd ~/lib/papi-components
-          npm run build:docs
-          mv docs papi-components
-          cd ~/lib/papi-dts
-          npm run build:docs
-          mv docs papi-dts
+        run: | # need to specify --out so pages links at /{their name} instead of at /docs
+          cd lib/papi-components
+          npm run build:docs -- --out papi-components
+          cd ../papi-dts
+          npm run build:docs -- --out papi-dts
+          cd ../../
+          mkdir docs-for-pages
+          mv lib/papi-components/papi-components docs-for-pages
+          mv lib/papi-dts/papi-dts docs-for-pages
+
+      - name: Add nojekyll # needed so that HTML pages that start with _ do not cause 404
+        run: touch docs-for-pages/.nojekyll
+
+      - name: Add landing page
+        run: |
+          cp .github/assets/github-pages-index.html docs-for-pages
+          mv docs-for-pages/github-pages-index.html docs-for-pages/index.html
 
       - name: Deploy to GitHub Pages
         uses: JamesIves/[email protected]
         with:
           branch: github-pages
-          folder: |
-            lib/papi-components/papi-components
-            lib/papi-dts/papi-dts
+          folder: docs-for-pages
diff --git a/lib/papi-components/package.json b/lib/papi-components/package.json
@@ -31,7 +31,7 @@
   "scripts": {
     "start": "vite --host --open",
     "build:basic": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
-    "build:docs": "npx typedoc",
+    "build:docs": "typedoc",
     "build": "npm run build:basic && npm run lint-fix",
     "watch": "tsc && vite build --watch",
     "lint": "npm run lint:scripts && npm run lint:styles",

diff --git a/lib/papi-components/typedoc.json b/lib/papi-components/typedoc.json
@@ -1,7 +1,7 @@
 {
-  "entryPoints": ["src"],
-  "entryPointStrategy": "expand",
-  "exclude": ["src/index.ts"],
+  "entryPoints": ["src/index.ts"],
   "out": "docs",
   "tsconfig": "tsconfig.json",
+  "sort": ["kind", "alphabetical"],
+  "kindSortOrder": ["Function"]
 }
diff --git a/lib/papi-dts/package.json b/lib/papi-dts/package.json
@@ -26,7 +26,7 @@
   "main": "",
   "types": "papi.d.ts",
   "scripts": {
-    "build:docs": "npx typedoc",
+    "build:docs": "typedoc",
     "build": "tsc && prettier --write papi.d.ts && ts-node edit-papi-d-ts.ts",
     "build:clean": "rimraf papi.tsbuildinfo",
     "build:fresh": "npm run build:clean && npm run build",