From af09d17666569655c104e5463566d72c72c417c6 Mon Sep 17 00:00:00 2001 From: Nicolas Peugnet Date: Sat, 8 Apr 2023 17:18:10 +0200 Subject: [PATCH 1/2] Fix include directive error Fixes the followinf error message: doc/index.rst:1: CRITICAL: Problems with "include" directive path: InputError: [Errno 2] No such file or directory: '../README'. This error may have appeared when upgrading the maximum Sphinx version. --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 5c643ef..ef09a2b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,4 +1,4 @@ -.. include:: ../README +.. include:: ../README.rst Contents: --------- From cfa4d87b5635f2f12d263afde1e1edc0f743cecc Mon Sep 17 00:00:00 2001 From: Nicolas Peugnet Date: Sat, 8 Apr 2023 17:21:09 +0200 Subject: [PATCH 2/2] Add GitHub action workflow to build & publish doc --- .github/workflows/doc.yml | 51 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/workflows/doc.yml diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..5af4c7d --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,51 @@ +name: Doc + +on: + # Runs on pushes targeting the default branch + push: + branches: [master] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install Python dependencies + run: pip install -r requirements.txt + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build doc + run: make -C doc html + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: doc/_build/html + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2