Skip to content

Added simple execution test #56

Added simple execution test

Added simple execution test #56

Workflow file for this run

# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: 2023 Berkay Bozkurt <[email protected]>
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pipenv
# if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
pipenv install --dev
- name: Generate Sphinx
run: |
cd src/docs
pipenv run sphinx-apidoc -o . ..
pipenv run make clean
pipenv run make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: src/docs/_build/html/
force_orphan: true