Skip to content

Workflow file for this run

name: documentation_dev
on:
pull_request_target:
branches:
- main
types: [closed]
push:
branches:
- main
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install -U sphinx
python -m pip install .
python -m pip install rlberry[torch,extras]@git+https://github.com/rlberry-py/rlberry
python -m pip install -r docs/requirements.txt
- name: Sphinx build
run: |
python -m sphinx docs _build
- uses: actions/checkout@v4
with:
# This is necessary so that we have the tags.
fetch-depth: 0
ref: gh-pages
path: gh_pages
- name: copy stable and preview version changes
run: |
cp -rv gh_pages/preview_pr _build/preview_pr || echo "Ignoring exit status"
- 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: _build/
force_orphan: true