Skip to content
Draft
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
46 changes: 0 additions & 46 deletions .github/workflows/deploy_mkdocs.yml

This file was deleted.

90 changes: 90 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: Publish docs via GitHub Pages

on:
push:
branches:
- main
paths:
# Only rebuild/deploy the website when docs have changed
- 'README.md'
- 'CHANGES.md'
- 'CONTRIBUTING.md'
- 'deployment/**'
- 'docs/**'
- '.github/workflows/docs.yml'
pull_request:
paths:
# Test the docs build whenever something that feeds the docs changes.
# The API reference and OpenAPI schema are generated from the source,
# so source/dependency changes can break the strict build too.
- 'README.md'
- 'CHANGES.md'
- 'CONTRIBUTING.md'
- 'deployment/**'
- 'docs/**'
- 'src/titiler/**'
- 'pyproject.toml'
- 'uv.lock'
- '.github/workflows/docs.yml'

Check notice

Code scanning / zizmor

insufficient job-level concurrency limits: workflow is missing concurrency setting Note

insufficient job-level concurrency limits: workflow is missing concurrency setting
Comment on lines +3 to +28

permissions:
contents: read

jobs:
test:
name: Test docs build
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false

- name: Install uv
uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
with:
version: "0.9.*"
enable-cache: false

- name: Generate OpenAPI schema
run: |
uv run python -c'from titiler.application.main import app; import json; print(json.dumps(app.openapi(), indent=4))' > docs/src/endpoints/openapi.json

- name: Build docs (strict)
run: |
uv run --group docs mkdocs build --strict -f docs/mkdocs.yml

deploy:
name: Deploy docs
needs: test
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
environment: github-pages
permissions:
contents: write # mkdocs gh-deploy pushes the built site to gh-pages
steps:
- name: Checkout main
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false

- name: Install uv
uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
with:
version: "0.9.*"
enable-cache: false

- name: Generate OpenAPI schema
run: |
uv run python -c'from titiler.application.main import app; import json; print(json.dumps(app.openapi(), indent=4))' > docs/src/endpoints/openapi.json

- name: Deploy docs
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
uv run --group docs mkdocs gh-deploy --force -f docs/mkdocs.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3 changes: 0 additions & 3 deletions src/titiler/xarray/titiler/xarray/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -432,9 +432,6 @@ def conformance(
Called with `GET /conformance`.
Returns:
Conformance classes which the server conforms to.
"""
data = {"conformsTo": sorted(TITILER_CONFORMS_TO)}

Expand Down
Loading