Skip to content

build documentation #28

build documentation

build documentation #28

Workflow file for this run

# .github/workflows/coverage.yml
name: build documentation
on:
workflow_run:
workflows: ["CI"]
types:
- completed
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install doc deps
run: |
pip install .[doc]
- name: prep sphinx
run: |
cd docs
sphinx-apidoc -f -o . ../src/
make html
- name: Commit documentation changes
run: |
git clone https://github.com/jan-glx/ICPy.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 changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}