Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit 0e5dd7b

Browse files
committed
ci(docs): deploy mkdocs to GH Pages
1 parent bbf8b84 commit 0e5dd7b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

.github/workflows/mkdocs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: MkDocs Publish
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "toggl_py/docs/**"
9+
- "toggl_py/mkdocs.yml"
10+
11+
defaults:
12+
run:
13+
shell: bash
14+
15+
jobs:
16+
test:
17+
uses: ./.github/workflows/pytest.yml
18+
19+
mkdocs:
20+
name: Publish docs
21+
runs-on: ubuntu-latest
22+
needs: test
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Download coverage report
28+
uses: actions/download-artifact@v4
29+
with:
30+
name: coverage-report
31+
path: toggl_py/docs/coverage
32+
33+
- name: Deploy docs
34+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
35+
env:
36+
REQUIREMENTS: toggl_py/docs/requirements.txt
37+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)