Skip to content

Commit

Permalink
[WIP] Trying building docs remotely
Browse files Browse the repository at this point in the history
  • Loading branch information
Leguark committed Sep 25, 2023
1 parent 4f0d6dc commit 9cd03cf
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/build_and_deploy_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Build and Deploy Sphinx Docs to GitHub Pages

on:
push:
branches:
- main # replace with your default branch

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.10' # replace x with your version

- name: Install Dependencies from requirements.txt
run: pip install -r requirements.txt

- name: Install Optional Dependencies from requirements_opt.txt
run: pip install -r requirements_opt.txt

- name: Install Dependencies from requirements_dev.txt
run: pip install -r requirements_dev.txt

- name: Build Sphinx Docs
run: make html # adjust based on your Makefile

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.LEGUARK_ACCESS_TOKEN }}
publish_dir: ./docs/build/html # replace with your generated HTML path

0 comments on commit 9cd03cf

Please sign in to comment.