-
Notifications
You must be signed in to change notification settings - Fork 141
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add workflow to build and publish docs
Add a workflow that, for now, builds Doxygen docs and published them on Github pages. Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
- Loading branch information
1 parent
838de92
commit bd518ad
Showing
2 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# 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: | | ||
cd doc | ||
doxygen | ||
SPHINXOPTS="-W" make html | ||
mkdir deploy | ||
mv _build_doxygen/html deploy/doxygen | ||
mv _build_sphinx/html deploy/sphinx | ||
- 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 |
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