diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..827460f20 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,23 @@ +name: Check autogenerated docs and build the documentation + +on: push + +jobs: + chech-autogenerated-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Remove the auto generated documentation source files + run: make -C docs cleanall + - name: Regenerate the autogenerated files + # run "true" instead of sphinx-build to speed things up + run: make -C docs html SPHINXBUILD=true + - name: Check that the generated docs where already commited + run: git diff --exit-code + + build-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Build the documentation + run: make -C docs html