Skip to content

Commit a35be3c

Browse files
authored
chore: publish docs (#68)
We use [mike](https://github.com/jimporter/mike). We get the version from `pyproject.toml`. These docs are currently deployed to https://nasa-impact.github.io/csda-client ... there's a couple manual steps before automatic deploys will work.
1 parent 1e4f7de commit a35be3c

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

.github/workflows/docs.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
permissions:
7+
contents: write
8+
9+
jobs:
10+
docs:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
- uses: astral-sh/setup-uv@v5
18+
- run: |
19+
git config user.name "github-actions[bot]"
20+
git config user.email "github-actions[bot]@users.noreply.github.com"
21+
- id: version
22+
run: echo "version=$(grep '^version' pyproject.toml | sed 's/version = "\(.*\)"/\1/')" >> "$GITHUB_OUTPUT"
23+
- run: uv run mike deploy --push --update-aliases ${{ steps.version.outputs.version }} latest

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ docs = [
2929
"rasterio>=1.4.3",
3030
"contextily>=1.6.2",
3131
"json-schema-for-humans>=1.4.1",
32+
"mike>=2.1.3",
3233
"mkdocs-material>=9.6.18",
3334
"mkdocs-jupyter>=0.25.1",
3435
"mkdocstrings[python]>=0.30.0",

uv.lock

Lines changed: 60 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)