docs: Add first Occamy documentation #2
Workflow file for this run
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
# Copyright 2023 ETH Zurich and University of Bologna. | |
# Licensed under the Apache License, Version 2.0, see LICENSE for details. | |
# SPDX-License-Identifier: Apache-2.0 | |
name: publish-docs | |
on: | |
push: | |
branches: [init] | |
workflow_dispatch: | |
jobs: | |
deploy: | |
name: Deploy documentation | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.x | |
- uses: mattnotmitt/doxygen-action@v1 | |
with: | |
working-directory: sw/ | |
- name: Generate Runtime Documentation | |
# yamllint disable rule:line-length | |
run: | | |
mkdir doxybook2; cd doxybook2 | |
wget https://github.com/matusnovak/doxybook2/releases/download/v1.4.0/doxybook2-linux-amd64-v1.4.0.zip | |
unzip doxybook2-linux-amd64-v1.4.0.zip; cd ../ | |
chmod +x doxybook2/bin/doxybook2 | |
mkdir docs/runtime | |
./doxybook2/bin/doxybook2 --input sw/doxygen/xml --output docs/runtime --config docs/doxybook2.json | |
rm -rf doxybook2 | |
# yamllint enable rule:line-length | |
- run: pip install -r docs/requirements.txt | |
- run: mkdocs gh-deploy --force |