Skip to content

Commit 6f110e2

Browse files
authored
Merge pull request #26 from graphras-com/ci/docs-deploy
Add GitHub Pages docs deployment workflow
2 parents e8d6f3d + fe7df79 commit 6f110e2

2 files changed

Lines changed: 43 additions & 2 deletions

File tree

.github/workflows/docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
permissions:
10+
contents: read
11+
12+
concurrency:
13+
group: docs-${{ github.ref }}
14+
cancel-in-progress: true
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: "3.11"
24+
- run: pip install -e ".[docs]"
25+
- run: mkdocs build --strict
26+
- if: github.event_name == 'push'
27+
uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: site/
30+
31+
deploy:
32+
if: github.event_name == 'push'
33+
needs: build
34+
runs-on: ubuntu-latest
35+
permissions:
36+
pages: write
37+
id-token: write
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deploy.outputs.page_url }}
41+
steps:
42+
- id: deploy
43+
uses: actions/deploy-pages@v4

pyproject.toml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ classifiers = [
2525
]
2626
dependencies = [
2727
"aiohttp>=3.9",
28-
"pydoc-markdown>=4.8.2",
29-
"tool>=0.8.0",
3028
]
3129

3230
[project.optional-dependencies]

0 commit comments

Comments
 (0)