Get typescript docs working

incremental progress on typescript docs

removing explicit typescript declaration

getting typescript docs working

let's see if secret works

update token name

bump version

typedoc install

npm install

specifically typedoc

global install

switching up version again

using 3.11

npm install, broad

modify env var syntax

.github/docs-update.yml

@@ -108,17 +108,17 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          # cloudflare build containers use 3.8, hence using it here
-          python-version: '3.8'
+          python-version: '3.11'
 
       - name: install
         run: |
           pip install --upgrade pip
           pip install -r requirements/docs.txt
-          pip install --extra-index-url https://pydantic:${MKDOCS_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python mkdocstrings-typescript
-
+          pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
+          npm install
+          npm install -g typedoc
         env:
-          MKDOCS_TOKEN: ${{ secrets.MKDOCS_TOKEN }}
+          PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }}
 
       - run: python -c 'import docs.plugins.main'
 

.github/workflows/ci.yml

@@ -43,13 +43,17 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          # cloudflare build containers use 3.8, hence using it here
-          python-version: '3.8'
+          python-version: '3.11'
 
       - name: install
         run: |
           pip install --upgrade pip
           pip install -r requirements/docs.txt
+          pip install --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
+          npm install
+          npm install -g typedoc
+        env:
+          PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }}
 
       - name: build site
         run: mkdocs build --strict

build-docs.sh

@@ -6,5 +6,8 @@ set -x
 python3 -V
 
 python3 -m pip install -r ./requirements/docs.txt
+pip install --extra-index-url https://pydantic:$PPPR_TOKEN@pppr.pydantic.dev/simple/ mkdocs-material mkdocstrings-python griffe-typedoc mkdocstrings-typescript
+npm install
+npm install -g typedoc
 
 python3 -m mkdocs build

docs/components.md → docs/api/python_components.md

@@ -1,4 +1,7 @@
+# Python Components
+
 ::: fastui.components
+    handler: python
     options:
         inherited_members: true
         docstring_options:

docs/api/typescript_components.md

@@ -0,0 +1,7 @@
+# TypeScript Components
+
+!!! warning "🚧 Work in Progress"
+    This page is a work in progress.
+
+::: @pydantic/fastui
+    handler: typescript

mkdocs.yml

@@ -94,4 +94,6 @@ plugins:
 nav:
   - Introduction: index.md
   - Guide: guide.md
-  - Components: components.md
+  - API Documentation:
+    - Python Components: api/python_components.md
+    - TypeScript Components: api/typescript_components.md

package.json

@@ -40,6 +40,7 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
-    "prettier": "^3.2.5"
+    "prettier": "^3.2.5",
+    "typedoc": "^0.25.13"
   }
 }

src/npm-fastui-bootstrap/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPointStrategy": "expand",
+  "entryPoints": ["src"]
+}

src/npm-fastui-prebuilt/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPointStrategy": "expand",
+  "entryPoints": ["src"]
+}

src/npm-fastui/src/models.d.ts

@@ -164,7 +164,7 @@ export interface PageEvent {
   pushPath?: string
   context?: ContextType
   clear?: boolean
-  nextEvent?: PageEvent | GoToEvent | BackEvent | AuthEvent
+  nextEvent?: AnyEvent
   type: 'page'
 }
 export interface ContextType {
@@ -191,7 +191,7 @@ export interface AuthEvent {
  */
 export interface Link {
   components: FastProps[]
-  onClick?: PageEvent | GoToEvent | BackEvent | AuthEvent
+  onClick?: AnyEvent
   mode?: 'navbar' | 'footer' | 'tabs' | 'vertical' | 'pagination'
   active?: string | boolean
   locked?: boolean
@@ -212,7 +212,7 @@ export interface LinkList {
  */
 export interface Navbar {
   title?: string
-  titleEvent?: PageEvent | GoToEvent | BackEvent | AuthEvent
+  titleEvent?: AnyEvent
   startLinks: Link[]
   endLinks: Link[]
   className?: ClassName
@@ -357,7 +357,7 @@ export interface DataModel {
 export interface DisplayLookup {
   mode?: DisplayMode
   title?: string
-  onClick?: PageEvent | GoToEvent | BackEvent | AuthEvent
+  onClick?: AnyEvent
   field: string
   tableWidthPercent?: number
 }
@@ -379,7 +379,7 @@ export interface Pagination {
 export interface Display {
   mode?: DisplayMode
   title?: string
-  onClick?: PageEvent | GoToEvent | BackEvent | AuthEvent
+  onClick?: AnyEvent
   value: JsonData
   type: 'Display'
 }

src/npm-fastui/typedoc.json

@@ -0,0 +1,8 @@
+// TODO: we really want the entryPoint to be src, but mkdocstrings-typescript doesn't fully support this option yet,
+// as we can't specify the path within the package from which we want to pull docs, so right now
+// we resort to more specific entryPoints
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPointStrategy": "expand",
+  "entryPoints": ["src/models.d.ts"]
+}

typedoc.base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true
+}

typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["./typedoc.base.json"],
+  "entryPointStrategy": "packages",
+  "entryPoints": ["./src/*"]
+}