Skip to content

Commit

Permalink
Create build-docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Zulko authored Nov 20, 2024
1 parent c36d23b commit 358d16b
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build and Deploy Sphinx Documentation

on:
push:
branches:
- main # Change to your default branch if needed

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x' # Specify Python version as needed

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt # Ensure your project dependencies are in this file
pip install sphinx # Add any additional Sphinx extensions or themes
- name: Build documentation
run: |
cd docs
make html # This should be adjusted to match your build process (e.g., `make html` or `sphinx-build`)
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html/ # Ensure this matches the output directory

0 comments on commit 358d16b

Please sign in to comment.