Skip to content
documentation

Migrate the documentation page from RTD to GHP. #2

Sign in to view logs

Migrate the documentation page from RTD to GHP.

Migrate the documentation page from RTD to GHP. #2

Workflow file for this run

.github/workflows/documentation.yml at 09ac93d
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
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme sphinx-tabs sphinx_copybutton myst_parser numpy torch
- name: Sphinx build
run: |
sphinx-build docs/src docs/build
- name: Deploy to GitHub Pages
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