Build Docs #1
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: | |
# Sequence of patterns matched against refs/tags | |
tags: | |
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 | |
workflow_dispatch: | |
inputs: | |
version: | |
description: Manual Doc Build | |
default: test | |
required: false | |
jobs: | |
docs: | |
name: build & push docs | |
runs-on: ${{ matrix.os }} | |
timeout-minutes: 90 | |
strategy: | |
matrix: | |
os: ['ubuntu-latest'] | |
environment-file: [ci/311.yaml] | |
experimental: [false] | |
defaults: | |
run: | |
shell: bash -l {0} | |
steps: | |
- name: checkout repo | |
uses: actions/checkout@v4 | |
- name: setup micromamba | |
uses: mamba-org/setup-micromamba@v1 | |
with: | |
environment-file: ${{ matrix.environment-file }} | |
micromamba-version: 'latest' | |
- name: reinstall for version | |
run: | | |
pip install -e . --no-deps --force-reinstall | |
- name: make docs | |
run: | | |
cd docs | |
make html | |
- name: commit docs | |
run: | | |
git clone https://github.com/ammaraskar/sphinx-action-test.git --branch gh-pages --single-branch gh-pages | |
cp -r docs/_build/html/* gh-pages/ | |
cd gh-pages | |
git config --local user.email "[email protected]" | |
git config --local user.name "GitHub Action" | |
git add . | |
git commit -m "Update documentation" -a || true | |
# The above command will fail if no changes were present, | |
# so we ignore the return code. | |
- name: push to gh-pages | |
uses: ad-m/github-push-action@master | |
with: | |
branch: gh-pages | |
directory: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
force: true |