From 98d70d467649828928e299c7c64656d7fed83d41 Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Wed, 3 Aug 2022 22:28:26 +0200 Subject: [PATCH] Publish documentation on push to develop branch (#3660) :construction_worker: add job to publish the documentation --- .github/workflows/publish_documentation.yml | 27 +++++++++++++++++++++ docs/docset/Makefile | 1 + docs/mkdocs/requirements.txt | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/publish_documentation.yml diff --git a/.github/workflows/publish_documentation.yml b/.github/workflows/publish_documentation.yml new file mode 100644 index 000000000..c06d535f0 --- /dev/null +++ b/.github/workflows/publish_documentation.yml @@ -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 diff --git a/docs/docset/Makefile b/docs/docset/Makefile index 6cdca4a03..eb1cfd38c 100644 --- a/docs/docset/Makefile +++ b/docs/docset/Makefile @@ -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) diff --git a/docs/mkdocs/requirements.txt b/docs/mkdocs/requirements.txt index 51fceb5d3..d51a6242c 100644 --- a/docs/mkdocs/requirements.txt +++ b/docs/mkdocs/requirements.txt @@ -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