Skip to content

Griffe TypeDoc¤

ci documentation pypi version gitter

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
typedoc.base.json
{
  "$schema": "https://typedoc.org/schema.json",
  "includeVersion": true
}
typedoc.json
{
  "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
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.

Sponsors¤

Silver sponsors

FastAPI

Bronze sponsors

Nixtla

ofek samuelcolvin tlambert03 ssbarnea femtomc cmarqu kolenaIO ramnes machow BenHammersley trevorWieland MarcoGorelli analog-cbarber OdinManiac rstudio-sponsorship schlich butterlyn livingbio NemetschekAllplan EricJayHartman 15r10nk activeloopai roboflow cmclaughlin RapidataAI rodolphebarbanneau theSymbolSyndicate blakeNaccarato ChargeStorm Cusp-AI

And 4 more private sponsor(s).