Merge pull request #223 from Farama-Foundation/Kallinteris-Andreas-pa… #66
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: Build main branch documentation website | |
on: | |
push: | |
branches: [main] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website | |
runs-on: ubuntu-latest | |
env: | |
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.9' | |
- name: Install docs requirements | |
run: pip install -r docs/requirements.txt | |
- name: Install requirements and Gymnasium-Robotics | |
run: pip install -e . | |
- name: Build Envs Docs | |
run: python docs/_scripts/gen_mds.py | |
- name: Build Envs Displays | |
run: 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: main | |
clean: false |