Skip to content

Commit

Permalink
Add query benchmark module and performance docs page
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
hrodmn committed Jan 7, 2025
1 parent 6da165b commit bbf5a59
Show file tree
Hide file tree
Showing 6 changed files with 4,717 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/deploy_mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ jobs:
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: Deploy docs
run: mkdocs gh-deploy --force -f docs/mkdocs.yml
7 changes: 7 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit bbf5a59

Please sign in to comment.