API docs.

Author: voxelstack

.github/workflows/typedoc.yml

@@ -0,0 +1,39 @@
+name: API docs
+on:
+    push:
+        branches:
+            - rewrite
+
+jobs:
+    # The main documentation is built by readthedocs.
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - run: corepack enable
+            - uses: actions/checkout@v5
+            - uses: actions/setup-node@v6
+              with:
+                  cache: "pnpm"
+            - name: Build
+              run: |
+                  pnpm install
+                  pnpm exec typedoc
+            - name: Upload
+              id: deployment
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: ./typedoc
+    deploy:
+        runs-on: ubuntu-latest
+        needs: build
+        permissions:
+            contents: read
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -3,3 +3,5 @@ dist
 
 .nyc_output
 coverage
+
+typedoc

.nycrc.json

@@ -1,6 +1,4 @@
 {
     "all": true,
-    "include": [
-        "src/**/*.ts"
-    ]
+    "include": ["src/**/*.ts"]
 }

README.md

@@ -1,4 +1,4 @@
-[![npm](https://github.com/voxelstack/ceres/actions/workflows/npm.yml/badge.svg)](https://www.npmjs.com/package/@voxelstack/ceres)
+[![NPM Version](https://img.shields.io/npm/v/%40voxelstack%2Fceres)](https://www.npmjs.com/package/@voxelstack/ceres)
 [![Documentation Status](https://readthedocs.org/projects/voxelstackceres/badge/?version=latest)](https://voxelstackceres.readthedocs.io/en/latest/)
 [![Coverage Status](https://coveralls.io/repos/github/voxelstack/ceres/badge.svg?branch=rewrite)](https://coveralls.io/github/voxelstack/ceres?branch=rewrite)
 

docs/conf.py

@@ -23,6 +23,15 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+print(subprocess.run(
+    ["npm", "pkg", "get", "version"],
+    capture_output=True,
+    encoding="utf-8",
+    check=True,
+    shell=True,
+    cwd=".."
+).stdout)
+
 project = "ceres"
 copyright = "2025, voxelstack"
 author = "voxelstack"

package.json

@@ -54,6 +54,7 @@
         "sinon": "^21.0.1",
         "sinon-chai": "^4.0.1",
         "tsx": "^4.21.0",
+        "typedoc": "^0.28.15",
         "typescript": "^5.9.3",
         "typescript-eslint": "^8.52.0"
     },