Skip to content
documentation

Update documentation.yml #5

Sign in to view logs

Update documentation.yml

Update documentation.yml #5

Workflow file for this run

.github/workflows/documentation.yml at 064deb3
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.8"
- name: Install dependencies
run: |
pip install sphinx==5.3.0 sphinx-autoapi==2.0.1 sphinx-rtd-theme==1.1.1 myst-nb==0.17.1
- name: Sphinx build
working-directory: ./python/docs
run: |
sphinx-build -b html . ./_build/html
- name: List HTML Output
run: ls -R ./python/docs/_build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/feature/DATATEAM-36/update-docs') }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./python/docs/_build/html
force_orphan: true