Add workflow overview #31
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
name: Build Sphinx Documentation | |
on: [workflow_call, pull_request] | |
permissions: | |
contents: write | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
defaults: | |
run: | |
working-directory: ./doc | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
- name: Install python dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
- name: Set up Java | |
uses: actions/setup-java@v3 | |
with: | |
distribution: 'adopt' | |
java-version: '11' | |
- name: Install plantuml | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y plantuml | |
- name: Build Sphinx documentation | |
run: make html OFFICIAL_BUILD=1 | |
- name: Zip Sphinx documentation | |
run: | | |
mv build/html sphinx_docs | |
zip -r sphinx_docs.zip sphinx_docs | |
- name: Upload sphinx_docs | |
uses: actions/upload-artifact@v4 | |
with: | |
name: sphinx_docs | |
path: ./doc/sphinx_docs.zip |