Manually Build Website #1
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: Manually Build Website | |
on: | |
workflow_dispatch: | |
inputs: | |
version: | |
description: 'Documentation version to create' | |
required: true | |
commit: | |
description: 'Commit used to build the Documentation version' | |
required: false | |
latest: | |
description: 'Latest version' | |
type: boolean | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website for new version | |
runs-on: ubuntu-latest | |
env: | |
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- uses: actions/checkout@v4 | |
if: inputs.commit == '' | |
- uses: actions/checkout@v4 | |
if: inputs.commit != '' | |
with: | |
ref: ${{ inputs.commit }} | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
- name: Install dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Install Gymnasium | |
run: pip install .[box2d,mujoco,jax] torch matplotlib | |
- name: Build Envs Docs | |
run: python docs/_scripts/gen_mds.py && python docs/_scripts/gen_envs_display.py | |
- name: Build | |
run: sphinx-build -b dirhtml -v docs _build | |
- name: Move 404 | |
run: mv _build/404/index.html _build/404.html | |
- name: Update 404 links | |
run: python docs/_scripts/move_404.py _build/404.html | |
- name: Remove .doctrees | |
run: rm -r _build/.doctrees | |
- name: Upload to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
folder: _build | |
target-folder: ${{ inputs.version }} | |
clean: false | |
- name: Upload to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
if: inputs.latest | |
with: | |
folder: _build | |
clean-exclude: | | |
*.*.*/ | |
main |