Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.
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
41 changes: 41 additions & 0 deletions .github/workflows/docs-build-ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build Documentation

on:
push:
branches:
- main
- develop
pull_request:
branches:
- main
- develop
types:
- opened
- synchronize


jobs:
build-docs:
name: Build documentation
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup Python and Pip
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: Install MKDocs with plugins
uses: BSFishy/pip-action@v1
with:
packages: |
mkdocs-material
mkdocs-git-revision-date-plugin

- name: Run 'mkdocs build'
run: mkdocs build
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ theme:

plugins:
- search:
prebuild_index: true
prebuild_index: true
- git-revision-date