Skip to content

build-documentation #21

build-documentation

build-documentation #21

Workflow file for this run

name: build-documentation
on:
# Allow us to manually build the documentation when desired
workflow_dispatch:
# Schedule the documentation to automatically build weekly if we forget to update it
# (Uncomment the following lines to re-enable this)
# schedule:
# - cron: '32 13 * * 1' # Mondays at 9:32 AM Eastern (13:32 UTC) (launch time for Apollo 11 :D)
jobs:
# Build the documentation and upload the static HTML files as an artifact.
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
# Install all dependencies
- run: |
pip install numpy
pip install wheel
pip install pybullet
pip install -e .
# Build documentation
# NOTE: we'll wrap this run with XVFB because without it we get an error from an import
# since there is no x server connection
- name: setup-xvfb # Fake display for headless build
uses: coactions/[email protected]
with:
# Deploy docs
run: portray on_github_pages -f