Add query benchmark module and performance docs page (#336)

* Add query benchmark module and performance docs page

- Simulates XYZ tile queries for collections with different item layouts
- Adds a new page to docs outlining tradeoffs between number of items
  and speed of queries
- Adds mkdocs-jupyter to the dependencies for the mkdocs site

* build docs on PRs where docs change

* add morecantile to test dependencies

Author: hrodmn

.github/workflows/deploy_mkdocs.yml

@@ -5,29 +5,38 @@ on:
     branches:
       - main
     paths:
-      # Only rebuild website when docs have changed
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
+  pull_request:
+    paths:
       - 'README.md'
       - 'CHANGELOG.md'
       - 'CONTRIBUTING.md'
       - 'docs/**'
 
 jobs:
-  build:
-    name: Deploy docs
+  docs:
+    name: ${{ github.event_name == 'push' && 'Deploy docs' || 'Build docs' }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout master
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install mkdocs mkdocs-material
+          python -m pip install mkdocs mkdocs-material mkdocs-jupyter pandas seaborn folium
+
+      - name: Build docs
+        if: github.event_name == 'pull_request'
+        run: mkdocs build -f docs/mkdocs.yml
 
       - name: Deploy docs
+        if: github.event_name == 'push'
         run: mkdocs gh-deploy --force -f docs/mkdocs.yml

docs/mkdocs.yml

@@ -20,11 +20,18 @@ nav:
   - Home: "index.md"
   - PgSTAC: "pgstac.md"
   - pyPgSTAC: "pypgstac.md"
+  - Performance:
+    - item_size_analysis.ipynb
   - Development - Contributing: "contributing.md"
   - Release Notes: "release-notes.md"
 
 plugins:
   - search
+  - mkdocs-jupyter:
+      include_source: True
+      include_requirejs: True
+      execute: True
+      show_input: False
 
 theme:
   name: material