Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add query benchmark module and performance docs page #336

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions .github/workflows/deploy_mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
Loading