Merge pull request #593 from Farama-Foundation/dependabot/github_acti… #23
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 and deploy docs | |
on: | |
push: | |
branches: [master] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website | |
runs-on: ubuntu-latest | |
env: | |
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.9' | |
- name: Install ViZDoom dependencies | |
run: sudo apt install cmake git libboost-all-dev libsdl2-dev libopenal-dev | |
- name: Install ViZDoom | |
run: pip install .[gym] | |
- name: Install docs dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Build docs | |
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 |