Skip to content

Commit

Permalink
Create update_docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Claudio9701 authored Jul 17, 2024
1 parent 634fbd1 commit 1550786
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/update_docs.yml
Original file line number Diff line number Diff line change
@@ -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 "[email protected]"
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 }}

0 comments on commit 1550786

Please sign in to comment.