Publish documentation on push to develop branch (#3660)

👷 add job to publish the documentation
pull/3670/head
Niels Lohmann 2022-08-03 22:28:26 +02:00 committed by GitHub
parent 22cd1c9eb9
commit 98d70d4676
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 1 deletions

View File

@ -0,0 +1,27 @@
name: Publish documentation
# publish the documentation on every merge to develop branch
on:
push:
branches:
- develop
# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications
concurrency:
group: documentation
cancel-in-progress: false
jobs:
publish_documentation:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- name: Install and update PlantUML
run: sudo apt-get install -y plantuml
- name: Install virtual environment
run: make install_venv -C docs/mkdocs
- name: Publish documentation
run: make publish -C docs/mkdocs

View File

@ -1,3 +1,4 @@
SHELL=/usr/bin/env bash
SED ?= $(shell which gsed 2>/dev/null || which sed)
MKDOCS_PAGES=$(shell cd ../mkdocs/docs/ && find * -type f -name '*.md' | sort)

View File

@ -30,7 +30,7 @@ mkdocs-simple-hooks==0.1.5
nltk==3.7
packaging==21.3
plantuml==0.3.0
plantuml-markdown==3.5.2
plantuml-markdown==3.6.3
Pygments==2.11.0
pymdown-extensions==9.3
pyparsing==3.0.8