From 818c1313e84ffb67375d7fb13527ab5867856c4c Mon Sep 17 00:00:00 2001 From: Patrick Kanzler <4189642+patkan@users.noreply.github.com> Date: Mon, 28 Sep 2020 20:55:13 +0200 Subject: [PATCH] Build documentation in Github action --- .github/workflows/documentation.yml | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..fd85eaa --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,33 @@ +# This is a basic workflow to help you get started with Actions + +name: Documentation build + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: Sphinx Build + # You may pin to the exact commit or the version. + # uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2 + uses: ammaraskar/sphinx-action@0.4 + with: + # The folder containing your sphinx docs. + docs-folder: doc/ + # The command used to build your documentation. + build-command: make html