Skip to content

Commit

Permalink
ci: add documentation building
Browse files Browse the repository at this point in the history
  • Loading branch information
Ljzd-PRO committed Dec 2, 2023
1 parent 0233fa1 commit 087e554
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Documentation
on:
push:
branches:
- master
paths:
- "ktoolbox/**"
- ".github/actions/setup-python/**"
- ".github/workflows/docs.yml"
- "pyproject.toml"
- "docs/**"
- "mkdocs.yml"

jobs:
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Setup Python environment
uses: ./.github/actions/setup-python
with:
python-version: "3.11"

- name: Build documentation
run: |
mkdocs build --clean
mkdocs --version
- name: Upload to GitHub Pages
uses: actions/upload-pages-artifact@v2
with:
path: site

- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v2

0 comments on commit 087e554

Please sign in to comment.