do not keep generated docs in git, generate before docs:build

also fix typedoc config
camptocamp · Oct 12, 2024 · 41c08b0 · 41c08b0
1 parent 2723c70
commit 41c08b0
Show file tree

Hide file tree

Showing 40 changed files with 7 additions and 1,792 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+api
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,5 +1,5 @@
-import { defineConfig } from 'vitepress'
-import typedocSidebar from '../api/typedoc-sidebar.json';
+import {defineConfig} from 'vitepress'
+import typedocSidebar from '../api/typedoc-sidebar.json'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -9,7 +9,8 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'API Reference', link: '/api/' }
+      { text: 'API Reference', link: '/api/' },
+      { text: 'Examples', link: 'https://camptocamp.github.io/geospatial-sdk/',  }
     ],
 
     sidebar: [

diff --git a/docs/api/core/functions/computeMapContextDiff.md b/docs/api/core/functions/computeMapContextDiff.md
diff --git a/docs/api/core/functions/deepFreeze.md b/docs/api/core/functions/deepFreeze.md
diff --git a/docs/api/core/functions/removeSearchParams.md b/docs/api/core/functions/removeSearchParams.md
diff --git a/docs/api/core/index.md b/docs/api/core/index.md
diff --git a/docs/api/core/interfaces/MapContext.md b/docs/api/core/interfaces/MapContext.md
diff --git a/docs/api/core/interfaces/MapContextBaseLayer.md b/docs/api/core/interfaces/MapContextBaseLayer.md
diff --git a/docs/api/core/interfaces/MapContextDiff.md b/docs/api/core/interfaces/MapContextDiff.md