From 1550786923f89b8208a6552889084bb281efc20a Mon Sep 17 00:00:00 2001 From: Claudio Ortega Date: Wed, 17 Jul 2024 22:58:23 +0200 Subject: [PATCH] Create update_docs.yml --- .github/workflows/update_docs.yml | 37 +++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/workflows/update_docs.yml diff --git a/.github/workflows/update_docs.yml b/.github/workflows/update_docs.yml new file mode 100644 index 0000000..c4defcc --- /dev/null +++ b/.github/workflows/update_docs.yml @@ -0,0 +1,37 @@ +# This workflow will: +# 1. Build docs using Sphinx +# 2. Push changes to this project gh-pages branch + +name: Update Docs + +on: [push, pull_request] + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + - name: Commit documentation changes + run: | + git clone https://github.com/EL-BID/urbanpy.git --branch gh-pages --single-branch gh-pages + cp -r docs/build/html/* gh-pages/ + cd gh-pages + git config --local user.email "claudio.rtega2701@gmail.com" + git config --local user.name "Claudio Ortega" + git add . + git commit -m "Update documentation" -a || true + # The above command will fail if no changes were present, so we ignore + # the return code. + - name: Push changes + uses: ad-m/github-push-action@master + with: + branch: gh-pages + directory: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }}