Skip to content

Merge pull request #472 from yoshitomo-matsubara/dev #180

Merge pull request #472 from yoshitomo-matsubara/dev

Merge pull request #472 from yoshitomo-matsubara/dev #180

name: Deploy Sphinx Documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.8'
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme
- name: Install torchdistill
run: |
pip install -e .
- name: Sphinx build
run: |
sphinx-build -b html docs/source/ docs/_build/
- name: Deploy
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/
force_orphan: true