Generated client docs (vitepress)

.github/workflows/deploy_docs.yaml

@@ -0,0 +1,69 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy Python SDK Documentation to Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  release:
+    types:
+      - created
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+          touch .vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: .vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.vitepress/config.mts

@@ -0,0 +1,66 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  ignoreDeadLinks: true,
+  title: "openrouteservice-py",
+  description: "🐍 The Python API to consume openrouteservice(s) painlessly! ",
+  base: '/openrouteservice-py/',
+  head: [
+    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "https://giscience.github.io/openrouteservice/ors_fav.png"}],
+  ],
+  markdown: {
+    anchor: {
+      slugify: (s) => encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '_'))
+    },
+  },
+  vite: {
+    publicDir: "./examples"
+  },
+  themeConfig: {
+    search: {
+      provider: 'local'
+    },
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Getting started', link: '/README' },
+      { text: 'Forum', link: 'https://ask.openrouteservice.org/c/sdks/10' },
+      { text: 'API Playground', link: 'https://openrouteservice.org/dev/#/api-docs' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Documentation',
+        link: 'README#documentation-for-api-endpoints',
+        items: [
+          { text: 'Directions GeoJSON', link: '/docs/DirectionsServiceApi#get_geo_json_route' },
+          { text: 'Directions JSON', link: '/docs/DirectionsServiceApi#get_json_route' },
+          { text: 'Elevation Line', link: '/docs/ElevationApi#elevation_line_post' },
+          { text: 'Elevation Point', link: '/docs/ElevationApi#elevation_point_post' },
+          { text: 'Geocode Autocomplete ', link: '/docs/GeocodeApi#geocode_autocomplete_get' },
+          { text: 'Reverse Geocode', link: '/docs/GeocodeApi#geocode_reverse_get' },
+          { text: 'Forward Geocode', link: '/docs/GeocodeApi#geocode_search_get' },
+          { text: 'Structured Forward Geocode', link: '/docs/GeocodeApi#geocode_search_structured_get' },
+          { text: 'Isochrones', link: '/docs/IsochronesServiceApi#get_default_isochrones'},
+          { text: 'Matrix', link: '/docs/MatrixServiceApi#get_default' },
+          { text: 'Optimization', link: '/docs/OptimizationApi#optimization_post' },
+          { text: 'POIs', link: '/docs/PoisApi#pois_post' }
+        ]
+      },
+      {
+        text: 'Examples',
+        items: [
+          { text: 'Avoid construction sites dynamically', link: 'https://openrouteservice.org/example-avoid-obstacles-while-routing/' },
+          { text: 'Dieselgate Routing', link: 'https://openrouteservice.org/dieselgate-avoid-berlin-banned-diesel-streets/' },
+          { text: 'Route optimization of pub crawl', link: 'https://openrouteservice.org/example-optimize-pub-crawl-with-ors/' },
+          { text: 'Routing optimization in humanitarian context', link: 'https://openrouteservice.org/disaster-optimization/' }
+        ]
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/GIScience/openrouteservice-py' },
+      { icon: 'x', link: 'https://twitter.com/ors_news' }
+    ]
+  },
+})

.vitepress/theme/custom.css

@@ -0,0 +1,54 @@
+:root {
+  --vp-c-brand-1: #b5152b;
+  --vp-button-brand-bg: #b5152b;
+  --vp-c-brand-2: #b5152b;
+  /* values below are taken from the old Jekyll installation of the docs */
+  --vp-font-family-base: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
+  --vp-font-family-mono: "SFMono-Regular", menlo, consolas, monospace;
+
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(120deg,
+      #b5152b 30%,
+      #f57124);
+}
+
+.vp-doc h1,
+.vp-doc h2,
+.vp-doc h3,
+.vp-doc h4,
+.vp-doc h5,
+.vp-doc h6 {
+  font-weight: 300;
+}
+
+:root {
+  --vp-layout-max-width: 1680px;
+}
+
+.content-container {
+  max-width: 100% !important;
+}
+
+/* min-width: 1440px same as original min-width: 960px */
+@media (min-width: 1440px) {
+  .VPSidebar {
+      padding-left: 32px !important;
+      width: var(--vp-sidebar-width) !important;
+  }
+  .VPContent.has-sidebar {
+      padding-left: var(--vp-sidebar-width) !important;
+      padding-right: 0 !important;
+  }
+}
+
+/* Add additional min-width: 1680px */
+@media (min-width: 1680px) {
+  .VPSidebar {
+      padding-left: calc((100% - (var(--vp-layout-max-width) - 64px)) / 2) !important;
+      width: calc((100% - (var(--vp-layout-max-width) - 64px)) / 2 + var(--vp-sidebar-width) - 32px) !important;
+  }
+  .VPContent.has-sidebar {
+      padding-left: calc((100vw - var(--vp-layout-max-width)) / 2 + var(--vp-sidebar-width)) !important;
+      padding-right: calc((100vw - var(--vp-layout-max-width)) / 2) !important;
+  }
+}

.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+