Skip to content

doc: use sphinx to generate documentation #6

doc: use sphinx to generate documentation

doc: use sphinx to generate documentation #6

Workflow file for this run

name: Build-sphinx-doc
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install ghp-import
- name: Build HTML
env:
TOKEN: ${{ secrets.TOKEN }}
run: |
sphinx-build -W docs docs/_build/html
- name: Run ghp-import to generate GitHub Pages
run: |
ghp-import -npfo docs/_build/html