update endpoints documentation

stac-utils · Oct 26, 2023 · 694e185 · 694e185 · github-actions · Oct 26, 2023
1 parent fea688e
commit 694e185
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 15 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,6 +7,12 @@ on:
     - main
     tags:
     - '*'
+    paths:
+      - 'tests/**'
+      - 'titiler/**'
+      - 'pyproject.toml'
+      - '.github/workflows/ci.yml'
+
   pull_request:
 env:
   LATEST_PY_VERSION: '3.10'

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -18,21 +18,22 @@ extra:
     default: latest
 
 nav:
-  - Home: "index.md"
-  - Intro: "intro.md"
+  - Home: index.md
+  - Intro: intro.md
   - Endpoints:
-    - Searches: "searches_endpoints.md"
-    - Collections: "collections_endpoints.md"
-    - Items: "items_endpoints.md"
-    - TileMatrixSet: "tms_endpoints.md"
-  - Tiler Factories: "tiler_factories.md"
+    - endpoints/index.md
+    - Searches: endpoints/searches_endpoints.md
+    - Collections: endpoints/collections_endpoints.md
+    - Items: endpoints/items_endpoints.md
+    - TileMatrixSet: endpoints/tms_endpoints.md
+  - Tiler Factories: tiler_factories.md
   - Advanced usage:
-    - Mosaic metadata specification: "advanced/metadata.md"
-    - Mosaic list: "advanced/searches_list.md"
-    - Custom search model: "advanced/custom_search.md"
-    - Custom TileJSON endpoint : "advanced/custom_tilejson.md"
+    - Mosaic metadata specification: advanced/metadata.md
+    - Mosaic list: advanced/searches_list.md
+    - Custom search model: advanced/custom_search.md
+    - Custom TileJSON endpoint : advanced/custom_tilejson.md
   - Examples:
-    - demo: "notebooks/demo.ipynb"
+    - demo: notebooks/demo.ipynb
   - API:
     - titiler.pgstac:
       - db: api/titiler/pgstac/db.md
@@ -45,9 +46,9 @@ nav:
       - settings: api/titiler/pgstac/settings.md
       - utils: api/titiler/pgstac/utils.md
   - Migration Guides:
-    - v0.8 -> v1.0: 'migrations/v1_migration.md'
-  - Development - Contributing: "contributing.md"
-  - Release notes: "release-notes.md"
+    - v0.8 -> v1.0: migrations/v1_migration.md
+  - Development - Contributing: contributing.md
+  - Release notes: release-notes.md
   - Performance Benchmarks: benchmark.html
 
 plugins:
@@ -59,6 +60,8 @@ theme:
   name: material
   favicon: img/favicon.ico
   logo: img/logo.png
+  features:
+    - navigation.indexes
 
 extra_css:
   - overrides/stylesheets/extra.css

diff --git a/docs/src/collections_endpoints.md → docs/src/endpoints/collections_endpoints.md b/docs/src/collections_endpoints.md → docs/src/endpoints/collections_endpoints.md
diff --git a/docs/src/endpoints/index.md b/docs/src/endpoints/index.md
@@ -0,0 +1,16 @@
+---
+
+title: Endpoints
+
+---
+
+<p align="center">
+  <img alt="titiler-pgstac OpenAPI documentation" src="https://github.com/stac-utils/titiler-pgstac/assets/10407788/5269249e-4005-4574-937a-b3563b2df2f5"/>
+</p>
+
+By default the main application (`titiler.pgstac.main.app`) provides three sets of endpoints:
+
+- [**Searches**](searches_endpoints.md): Dynamic **mosaic** tiler based on PgSTAC Search Query
+- [**Collections**](collections_endpoints.md): Dynamic **mosaic** tiler based on STAC Collection
+- [**Items**](items_endpoints.md): Dynamic tiler for single STAC item (stored in PgSTAC)
+- [**TileMatrixSet**](tms_endpoints.md): Available TileMatrixSets for the service
diff --git a/docs/src/items_endpoints.md → docs/src/endpoints/items_endpoints.md b/docs/src/items_endpoints.md → docs/src/endpoints/items_endpoints.md
diff --git a/docs/src/searches_endpoints.md → docs/src/endpoints/searches_endpoints.md b/docs/src/searches_endpoints.md → docs/src/endpoints/searches_endpoints.md
diff --git a/docs/src/tms_endpoints.md → docs/src/endpoints/tms_endpoints.md b/docs/src/tms_endpoints.md → docs/src/endpoints/tms_endpoints.md
Benchmark suite	Current: `694e185`	Previous: `fea688e`	Ratio
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[0/0/0]`	`2.3807941443038305` iter/sec (`stddev: 0.017561085529793054`)	`3.103882645186873` iter/sec (`stddev: 0.007771199825156561`)	`1.30`
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[2/2/1]`	`5.750436314115982` iter/sec (`stddev: 0.0018364972249307393`)	`7.808565329509389` iter/sec (`stddev: 0.006204269681076905`)	`1.36`
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[3/5/0]`	`12.075857202006642` iter/sec (`stddev: 0.004537456199124991`)	`16.58382130287634` iter/sec (`stddev: 0.0033537855678115354`)	`1.37`
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[4/5/9]`	`16.32577508510354` iter/sec (`stddev: 0.006707566889904753`)	`22.51450490545945` iter/sec (`stddev: 0.0039050087657066953`)	`1.38`
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[5/16/5]`	`15.995684509347914` iter/sec (`stddev: 0.005806354531109036`)	`21.57044716985367` iter/sec (`stddev: 0.004403934506586983`)	`1.35`
`.github/workflows/tests/benchmarks.py::test_benchmark_tile[6/43/31]`	`14.65432816784337` iter/sec (`stddev: 0.00472913341502751`)	`19.965412341150813` iter/sec (`stddev: 0.003671157854089316`)	`1.36`