Skip to content

chore: restructured folders to improve maintainability #12

chore: restructured folders to improve maintainability

chore: restructured folders to improve maintainability #12

Workflow file for this run

# SPDX-FileCopyrightText: © 2024 Adrian C. Prelipcean
#
# SPDX-License-Identifier: CC0-1.0
name: documentation
on: [push]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install doxygen
run: |
sudo apt update
sudo apt install -y doxygen
- name: Cache requirements
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install requirements
if: steps.cache.outputs.cache-hit != 'true'
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Sphinx build
run: |
doxygen Doxygen && sphinx-build docs/ docs/_build/ -a
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/
force_orphan: true