diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml new file mode 100644 index 0000000..3ad92d8 --- /dev/null +++ b/.github/workflows/docs-build-ci.yaml @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 867fb3d..a163b9b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,5 +9,5 @@ theme: plugins: - search: - prebuild_index: true + prebuild_index: true - git-revision-date