DOC: Add documentation build status badge to README file (#68) #32
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build docs | |
on: | |
push: | |
branches: | |
- master | |
tags: | |
- 'v*' | |
pull_request: | |
branches: | |
- master | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade --user pip setuptools coverage | |
pip install .[doc] | |
- name: Build docs | |
run: | | |
make -C doc/ SPHINXOPTS="-v" BUILDDIR="$HOME/docs" OUTDIR="$HOME/html" html |