Skip to content
Docs

add basic sphinx docs build using apidoc #5

Sign in to view logs

add basic sphinx docs build using apidoc

add basic sphinx docs build using apidoc #5

Workflow file for this run

.github/workflows/sphinx.yml at ba4931b
name: Docs
on:
workflow_dispatch:
pull_request:
push:
branches:
- master
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Ubuntu build deps
run: |
sudo apt-get -qq update
sudo apt-get install -y libre2-dev
- uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Add python requirements
run: |
python -m pip install --upgrade pip
pip install tox
- name: Install Ubuntu build deps
run: |
sudo apt-get -qq update
sudo apt-get install -y libre2-dev
- name: Build docs
run: |
tox -e ldocs,docs
- uses: actions/upload-artifact@v4
with:
name: ApiDocsHTML
path: "docs/_build/html/"
- name: set nojekyll for github
run: |
touch docs/_build/html/.nojekyll
- name: Deploy docs to gh-pages
if: ${{ github.event_name == 'push' }}
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_build/html/
single-commit: true