From af0e9a504def00eb298acf7aff9d4cabed273f65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Brunner?= Date: Wed, 7 Sep 2022 13:15:38 +0200 Subject: [PATCH] Fix the documentation --- .github/workflows/main.yaml | 2 +- buildtools/doc-readme.md | 2 +- typedoc.json | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 119538c2dfcf..ea52e364732e 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -117,8 +117,8 @@ jobs: if: failure() # Generate API doc, api, lib - - run: npm run doc - run: npm run doc -- srcapi/store/config.ts --json dist/typedoc.json + - run: npm run doc - run: npm run build-api - run: npm run dist - run: npm run dist-spinner diff --git a/buildtools/doc-readme.md b/buildtools/doc-readme.md index d1b66ccb4b77..409b0e50eb97 100644 --- a/buildtools/doc-readme.md +++ b/buildtools/doc-readme.md @@ -4,7 +4,7 @@ API documentation of ngeo. [API constants definitions](modules/srcapi_store_config.html#APIConfig) -[Themes API](interfaces/contribs_gmf_src_themes.GmfTheme.html) +[Themes API](modules/src_themes.html) Note that the stable API is in [srcapi](modules/srcapi.html) and will be available directly on `window`. The rest of the API can change without any notice. diff --git a/typedoc.json b/typedoc.json index 0f570183ceeb..5ea6e4e43def 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,4 +1,5 @@ { + "$schema": "https://typedoc.org/schema.json", "name": "ngeo", "entryPoints": ["src", "srcapi", "api/src"], "entryPointStrategy": "expand",