Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish documentation on push to develop branch #3660

Merged
merged 15 commits into from
Aug 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/publish_documentation.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/docset/Makefile
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down