Merge pull request #33 from senju1337/feat/OPS-63-docsgen

setup a simple generation for the documentation OPS-63
This commit is contained in:
An0nymous 2025-03-21 15:36:25 +00:00 committed by GitHub
commit ee16a4bf8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

54
.github/workflows/gendocs.yml vendored Normal file
View file

@ -0,0 +1,54 @@
name: Build and Store Documentation Artifact
on:
push:
branches:
- master
- devel
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx poetry
poetry install
- name: Build Sphinx documentation
run: |
cd docs && ls
bash auto_docu.sh
- name: Upload documentation files as artifact
id: deployment
uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action
with:
path: docs/build/html/
deploy:
needs: build
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4