aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/.github
diff options
context:
space:
mode:
authorHsiangNianian <i@jyunko.cn>2025-10-06 01:12:42 +0800
committerHsiangNianian <i@jyunko.cn>2025-10-06 01:12:42 +0800
commit12c771ae7152520f7465e96e600daed4abf14ddc (patch)
tree36d38c5ae462a66a041ddb6d54ff8a673a107eff /.github
parent8e6fdbf4cf68185ab9318637af0c40cdb5f66b48 (diff)
downloadOneRoll-12c771ae7152520f7465e96e600daed4abf14ddc.tar.gz
OneRoll-12c771ae7152520f7465e96e600daed4abf14ddc.zip
feat: add GitHub Actions workflow for building and deploying documentation
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/docs.yml45
1 files changed, 45 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..ae08911
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,45 @@
+name: Build and Deploy Docs
+
+on:
+ push:
+ branches:
+ - main
+ - dev
+ workflow_dispatch:
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v5
+
+ - name: Install uv
+ uses: astral-sh/setup-uv@v6
+
+ - name: Install dependencies
+ run: |
+ uv sync --all-groups
+
+ - name: Build documentation
+ run: |
+ cd docs
+ make html
+
+ - name: Build LaTeX PDF file
+ run: |
+ make latex
+ cd _build/latex
+ make
+ cp *.pdf ../html/_static/
+
+ - name: Deploy to GitHub Pages
+ if: github.ref == 'refs/heads/main'
+ uses: peaceiris/actions-gh-pages@v4
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./docs/build/html
+ publish_branch: gh-pages
+ user_name: "hydroroll-bot"
+ user_email: "bot@hydroroll.team"