Skip to content

add docs Makefile

add docs Makefile #13

Workflow file for this run

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@v3
- 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 .
- 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