From 20b78a5289a88fd676ca06677439c04a67201dfc Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 16:29:59 -0500 Subject: [PATCH 1/8] update workflow yaml --- .github/workflows/docs_pages.yaml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index aac7f71..920a606 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -1,10 +1,7 @@ name: Docs2Pages -on: - push: - tags: '*' - pull_request: - branches: - - master +on: [push, pull_request, workflow_dispatch] +permissions: + contents: write jobs: build-docs: From c9b1b8f21eccdc167df89114cf9d2df18d79e7b1 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 16:34:20 -0500 Subject: [PATCH 2/8] update workflow to try and fix build errors --- .github/workflows/docs_pages.yaml | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index 920a606..b3f64dd 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -8,25 +8,19 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@master - with: - fetch-depth: 0 - - uses: actions/setup-python@v2 - with: - python-version: 3.9 + uses: actions/checkout@v3 + - uses: actions/setup-python@v4 - uses: abatilo/actions-poetry@v2.1.3 - name: install run: poetry install -E amazon -E docs - - name: Build documentation + - name: Sphinx build run: | - mkdir gh-pages - touch gh-pages/.nojekyll - cd docs/ - poetry run sphinx-build -b html . _build - cp -r _build/* ../gh-pages/ + sphinx-build -b html docs/source docs/build/html - name: Deploy documentation - if: ${{ github.event_name == 'push' }} - uses: JamesIves/github-pages-deploy-action@4.1.4 + uses: peaceiris/actions-gh-pages@v3 + if: github.event_name == 'push' && github.ref == 'refs/heads/master' with: - branch: gh-pages - folder: gh-pages \ No newline at end of file + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/build/html + force_orphan: true \ No newline at end of file From a216009bc92c84a65bf44684de644fc60190ccd6 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 16:46:25 -0500 Subject: [PATCH 3/8] try again with action fixes --- .github/workflows/docs_pages.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index b3f64dd..6bcdadd 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -11,8 +11,13 @@ jobs: uses: actions/checkout@v3 - uses: actions/setup-python@v4 - uses: abatilo/actions-poetry@v2.1.3 - - name: install - run: poetry install -E amazon -E docs + + - name: Install Poetry + uses: snok/install-poetry@v1 + + - name: Install dependencies + run: | + poetry install --with dev - name: Sphinx build run: | sphinx-build -b html docs/source docs/build/html From c9be2ba17f4e79b660a4698faeeeafb68d63b115 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 16:50:15 -0500 Subject: [PATCH 4/8] update python version in runner --- .github/workflows/docs_pages.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index 6bcdadd..bef4b3f 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -9,8 +9,9 @@ jobs: steps: - name: Checkout uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - - uses: abatilo/actions-poetry@v2.1.3 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' - name: Install Poetry uses: snok/install-poetry@v1 @@ -18,9 +19,11 @@ jobs: - name: Install dependencies run: | poetry install --with dev + - name: Sphinx build run: | sphinx-build -b html docs/source docs/build/html + - name: Deploy documentation uses: peaceiris/actions-gh-pages@v3 if: github.event_name == 'push' && github.ref == 'refs/heads/master' From c52b9dbc6900665c07e475fb2ed85327b09667e8 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 17:10:59 -0500 Subject: [PATCH 5/8] update sphinx command --- .github/workflows/docs_pages.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index bef4b3f..bbc5fb9 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -22,7 +22,7 @@ jobs: - name: Sphinx build run: | - sphinx-build -b html docs/source docs/build/html + sphinx-build -M html docs/source docs/build/html - name: Deploy documentation uses: peaceiris/actions-gh-pages@v3 From b7aaaac0dd3feb7fb86613ca8f162aaad95f7cf6 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 17:18:52 -0500 Subject: [PATCH 6/8] update sphinx command for poetry env --- .github/workflows/docs_pages.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index bbc5fb9..0e0351e 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -19,10 +19,11 @@ jobs: - name: Install dependencies run: | poetry install --with dev + sphinx- - name: Sphinx build run: | - sphinx-build -M html docs/source docs/build/html + poetry run sphinx-build -M html docs/source docs/build/html - name: Deploy documentation uses: peaceiris/actions-gh-pages@v3 From b930cc110c2789dee0c9b792068f3fb6a059f1f6 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 17:26:37 -0500 Subject: [PATCH 7/8] update sphinx command for poetry env --- .github/workflows/docs_pages.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index 0e0351e..0eadf92 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -19,7 +19,6 @@ jobs: - name: Install dependencies run: | poetry install --with dev - sphinx- - name: Sphinx build run: | From 14c989244e782b98c6251bba9b56c067dc567856 Mon Sep 17 00:00:00 2001 From: Ian Patterson Date: Tue, 25 Jun 2024 17:48:08 -0500 Subject: [PATCH 8/8] update sphinx directory --- .github/workflows/docs_pages.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_pages.yaml b/.github/workflows/docs_pages.yaml index 0eadf92..4abb285 100644 --- a/.github/workflows/docs_pages.yaml +++ b/.github/workflows/docs_pages.yaml @@ -22,7 +22,7 @@ jobs: - name: Sphinx build run: | - poetry run sphinx-build -M html docs/source docs/build/html + poetry run sphinx-build -M html docs/source docs/build/ - name: Deploy documentation uses: peaceiris/actions-gh-pages@v3