added github pages workflow
This commit is contained in:
parent
26f5bc26aa
commit
35849425b4
36
.github/workflows/deploy-docs.yml
vendored
Normal file
36
.github/workflows/deploy-docs.yml
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
name: Deploy Sphinx Docs to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main # Adjust this if your default branch is not 'main'
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: '3.12' # Specify the Python version you need
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install sphinx
|
||||
pip install -r docs/requirements.txt # Adjust if you have additional requirements
|
||||
|
||||
- name: Build documentation
|
||||
run: |
|
||||
cd docs
|
||||
make html
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/_build/html
|
Loading…
x
Reference in New Issue
Block a user