Skip to content

WIP: Creation of Python autodoc using Sphinx #4

WIP: Creation of Python autodoc using Sphinx

WIP: Creation of Python autodoc using Sphinx #4

Workflow file for this run

name: "Sphinx: Render docs"
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx>=5.0.0
# Install other dependencies if needed
pip install -r requirements.txt
- name: Build documentation
run: |
cd docs
make html
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: documentation
path: docs/_build/html/
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html