Files
mellifera_firmware/.github/workflows/docs.yml
Brendan Haines 4bf9ac8970
Some checks failed
Build / build (macos-12) (push) Has been cancelled
Build / build (macos-14) (push) Has been cancelled
Build / build (windows-2022) (push) Has been cancelled
Build / build (ubuntu-22.04) (push) Has been cancelled
Documentation / build (push) Failing after 13s
Documentation / deploy (push) Has been skipped
hardcode timezone to workaround bug in babel
2024-04-21 22:55:55 -06:00

63 lines
1.6 KiB
YAML

# Copyright (c) 2024, Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
name: Documentation
on: [push, pull_request]
env:
DOXYGEN_VERSION: 1.9.6
jobs:
build:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install dependencies
run: |
wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
pip install -r doc/requirements.txt
- name: Build
run: |
export TZ=UTC
cd doc
doxygen
SPHINXOPTS="-W" make html
mkdir deploy
mv _build_doxygen/html deploy/doxygen
mv _build_sphinx/html/* deploy
- name: Setup pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@v4
- name: Upload pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: doc/deploy
- name: Upload artifacts
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v4
with:
path: doc/deploy
deploy:
runs-on: ubuntu-22.04
needs: build
if: github.event_name != 'pull_request'
permissions:
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4