Skip to content

Commit

Permalink
Added sphinx docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
KDharmarajanDev committed Feb 27, 2024
1 parent 370a42a commit a45a40c
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/create-documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build Sphinx Documentation

on:
push:
branches:
- main # You can change this to whatever branch you want to trigger the build
pull_request:
branches:
- main

jobs:
build:
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.8.18'

- name: Change to xembody Directory
run: cd xembody
working-directory: xembody

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Build Documentation
run: |
make -C docs/ html # Assuming your Sphinx documentation is located in a directory named "docs"
- name: Upload Documentation Artifacts
uses: actions/upload-artifact@v2
with:
name: docs
path: docs/build/html # Adjust this path if your Sphinx output is in a different directory

0 comments on commit a45a40c

Please sign in to comment.