Griffe TypeDoc

Signatures for entire TypeScript programs using TypeDoc.

Installation

pip install griffe-typedoc

With uv:

uv tool install griffe-typedoc

Usage

Add these TypeDoc configuration files to your repository:

./
    src/
        package1/
    typedoc.base.json
    typedoc.json

{
  "$schema": "https://typedoc.org/schema.json",
  "includeVersion": true
}

{
  "extends": ["./typedoc.base.json"],
  "entryPointStrategy": "packages",
  "entryPoints": ["./src/*"]
}

Update the entrypoints to match your file layout so that TypeDoc can find your packages. See TypeDoc's configuration documentation.

Then in each of your package, add this TypeDoc configuration file:

./
    src/
        package1/
            typedoc.json
    typedoc.base.json
    typedoc.json

{
  "extends": ["../../typedoc.base.json"],
  "entryPointStrategy": "expand",
  "entryPoints": ["src/index.d.ts"]
}

Again, update entrypoints to match your file and package layout. See TypeDoc's configuration documentation.

Your packages must be built for TypeDoc to work.

Finally, load your TypeScript API data with Griffe TypeDoc:

from griffe_typedoc.loader import load

data = load(
    "typedoc",  # name or path of the typedoc executable
    working_directory=".",  # point at your monorepo
)

See our API reference.

Metadata

Release files for griffe-typedoc 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for griffe-typedoc 0.1.1
File	Size	Uploaded
griffe_typedoc-0.1.1.tar.gz	44.9 kB	Oct 6, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for griffe-typedoc 0.1.1
File	Interpreter	ABI	Platform	Reset
griffe_typedoc-0.1.1-py3-none-any.whl 24.9 kB Oct 6, 2026	Python 3	none	any	Details

Total release size: 69.7 kB

Release files / griffe_typedoc-0.1.1.tar.gz

Download URL	griffe_typedoc-0.1.1.tar.gz
Size	44.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`eba5da8efe3d521d557e3ad4d62b2e9ebdae5a79328e0c9d37dc7306c34a6807`
BLAKE2b-256 checksum How to use checksums	`a4ba886c811515cc0adbd6e3015fcbdc298af310e55dece4400399f27c7d88db`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.8`

Release files / griffe_typedoc-0.1.1-py3-none-any.whl

Download URL	griffe_typedoc-0.1.1-py3-none-any.whl
Size	24.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`19f786c1ea5607b02f8356354ba56fcb1a57ce70af877b41647afb724ff5607c`
BLAKE2b-256 checksum How to use checksums	`ac862ef3b9f1d1f1eaef7c22950f787d5bcc0104d2ff3640e604bb693d0bdbc2`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.8`