summaryrefslogtreecommitdiffstats
path: root/.github/workflows/docs.yml
blob: 67d6c82903b6f3d4629d8a0cd5203f50f2d15ce1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
name: docs
on:
  workflow_dispatch:
    # inputs:
    #   version:
    #     description: "The documentation version to update. Defaults to nightly."
    #     default: "nightly"
    #     required: false
  push:
    branches:
      - master
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
jobs:
  build-documentation:
    name: Build and deploy docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - run: pip install mkdocs-material
      - run: pip install mdx_truly_sane_lists
      - run: cd docs/
      - run: mkdocs gh-deploy --force