spatialmath-python/.github/workflows/sphinx.yml at master · rai-opensource/spatialmath-python · GitHub

View runs

History

46 lines (44 loc) · 1.38 KB

Raw

name: Sphinx

on:

workflow_call:

jobs:

sphinx:

runs-on: ubuntu-22.04

# if: ${{ github.event_name != 'pull_request' }}

steps:

- uses: actions/checkout@v4

- name: Set up Python 3.12

uses: actions/setup-python@v5

with:

python-version: 3.12

- name: Install dependencies

run: |

python -m pip install --upgrade pip

pip install .[dev,docs]

pip install git+https://github.com/petercorke/sphinx-autorun.git

pip install sympy

sudo apt-get install graphviz

- name: Build docs

run: |

cd docs

make html

# Tell GitHub not to use jekyll to compile the docs

touch build/html/.nojekyll

cd ../

- name: Commit documentation changes

run: |

git clone https://github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages

cp -r docs/build/html/* gh-pages/

cd gh-pages

git config --local user.email "action@github.com"

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

# that.

- name: Push changes

uses: ad-m/github-push-action@master

with:

branch: gh-pages

directory: gh-pages

github_token: ${{ secrets.GITHUB_TOKEN }}

spatialmath-python/.github/workflows/sphinx.yml at master · rai-opensource/spatialmath-python · GitHub

Expand file tree

Breadcrumbs

sphinx.yml

Latest commit

History

Breadcrumbs

sphinx.yml

File metadata and controls