Skip to content

Doc

Doc #316

Workflow file for this run

name: Doc
on:
push:
pull_request:
workflow_dispatch:
schedule:
- cron: '0 0 * * 5'
env:
CI: true
DOCKER_BUILDKIT: 1
jobs:
doc:
runs-on: ubuntu-latest
name: '📓 Docs'
steps:
- name: '🧰 Checkout'
uses: actions/checkout@v3
- name: '🛳️ Build osvb/doc'
run: |
docker build -t osvb/doc - <<-EOF
FROM ghcr.io/hdl/sim/osvb@sha256:ca08fcc7906bd34108f9bc9ef9d981045e65b09cc4961a5d271468888cfea7dc
ENV PYTHONPATH=/src/mods
RUN apt update -qq && apt install -y \
git \
make \
python3-pip \
python3-setuptools \
python3-tk \
&& pip3 install git+https://github.com/ghdl/ghdl.git@\$(ghdl version hash)
EOF
- name: '📓 BuildTheDocs (BTD)'
uses: buildthedocs/btd@v0
with:
token: ${{ github.token }}
skip-deploy: ${{ github.event_name == 'pull_request' }}
- name: '📤 Upload artifact: HTML'
if: github.event_name != 'pull_request'
uses: actions/upload-artifact@v3
with:
path: doc/_build/html