diff --git a/.github/workflows/building_docs_test.yml b/.github/workflows/building_docs_test.yml new file mode 100644 index 0000000000000000000000000000000000000000..221b3661d36940fa8bcfeedec600a9c33b9586f8 --- /dev/null +++ b/.github/workflows/building_docs_test.yml @@ -0,0 +1,22 @@ +# This test will be triggered if at least one file was changed inside the `docs` folder. +# It checks whether all syntax of the doc files is correct. +# If there are any errors information about them will be in the `files changed` tub of the pull request. + +name: Building docs test +on: + pull_request: + paths: + - "docs/**" + +jobs: + build_docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: ammaraskar/sphinx-action@master + with: + + # sphinx properties + # https://www.sphinx-doc.org/en/master/man/sphinx-build.html + # https://www.sphinx-doc.org/en/master/usage/builders/index.html?highlight=DummyBuilder#sphinx.builders.dummy.DummyBuilder + build-command: sphinx-build -W --keep-going -b dummy . _test