Skip to content

Update main docs page #50

Update main docs page

Update main docs page #50

Workflow file for this run

name: documentation
on:
pull_request:
push:
branches:
- main
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install -r requirements/development.txt
pip install -r requirements/documentation.txt
- name: Sphinx build
run: make clean && make doc
- name: Extract branch name
shell: bash
run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
id: extract_branch
- name: Deploy to GitHub Pages (branch)
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name != 'push' && github.ref != 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
destination_dir: branch/${{ steps.extract_branch.outputs.branch }}
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
destination_dir: ./
keep_files: true
- name: Create files for redeploy
run: |
rm -rf tmp/bump
mkdir -p tmp/bump
echo $(date +"%Y-%m-%dT%H%M%S") > tmp/bump/last_deploy
- name: Force redeploy of GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: tmp/bump
destination_dir: ./
keep_files: true