mirror of
https://github.com/RYDE-WORK/ballistica.git
synced 2026-02-06 23:59:18 +08:00
Added workflow for deploying docs to github pages
This commit is contained in:
parent
dd571bab64
commit
ffd39ed59c
34
.github/workflows/deploy_docs.yml
vendored
Normal file
34
.github/workflows/deploy_docs.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
name: Deploy Documentation
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
# Remove this once we upgrade to 3.12.
|
||||||
|
|
||||||
|
- name: Install typing_extensions (temp)
|
||||||
|
run: python3.11 -m pip install typing_extensions
|
||||||
|
|
||||||
|
- name: Install pip requirements
|
||||||
|
run: tools/pcommand install_pip_reqs
|
||||||
|
|
||||||
|
- name: Build documentation
|
||||||
|
run: make docs-sphinx
|
||||||
|
|
||||||
|
- name: Deploy documentation
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
publish_dir: build/sphinx
|
||||||
Loading…
x
Reference in New Issue
Block a user