Update README.md #312
Workflow file for this run
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 and Deploy docs | |
on: | |
push: | |
branches: [ main ] | |
pull_request: | |
branches: [ main ] | |
release: | |
types: | |
- created | |
jobs: | |
docs: | |
name: build and deploy docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: Set system to non-interactive mode | |
run: export DEBIAN_FRONTEND=noninteractive | |
- name: install dependencies | |
run: | | |
pip install sphinx | |
pip install sphinx-rtd-theme | |
pip install sphinx-multiversion | |
- name: build docs | |
run: | | |
echo "Repo = ${GITHUB_REPOSITORY}" | |
cd doc/sphinx | |
make multiversion | |
- name: Deploy | |
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }} | |
uses: peaceiris/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./doc/sphinx/_build/html | |
force_orphan: true |