Update docs #61
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation | |
on: | |
push: | |
branches: | |
- main | |
pull_request: {} | |
release: | |
types: | |
- published | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.11 | |
- name: Install | |
env: | |
SECRET_GITHUB_TOKEN: ${{ secrets.SECRET_GITHUB_TOKEN }} | |
run: | | |
python -m pip install -U pip | |
pip install --progress-bar off . | |
pip install --progress-bar off PyGitHub | |
pip install --progress-bar off git+https://${SECRET_GITHUB_TOKEN}@github.com/optuna/optunahub.git | |
pip install --progress-bar off ".[docs]" | |
- name: Build | |
env: | |
SECRET_GITHUB_TOKEN: ${{ secrets.SECRET_GITHUB_TOKEN }} | |
OPTUNAHUB_NO_ANALYTICS: 1 | |
run: | | |
cd docs | |
make html | |
cd .. | |
- name: Deploy | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/build/html | |
deploy: | |
if: github.event_name != 'pull_request' | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |