Skip to content

Commit

Permalink
Add workflow to render documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebromero committed Oct 4, 2024
1 parent 39f4cf0 commit 575d66b
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/render-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Render Documentation

on:
push:
branches:
- main
- docs
paths:
- ".github/workflows/render-documentation.ya?ml"
- "src/**"
workflow_dispatch:

jobs:
render-docs:
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
if: github.event_name != 'pull_request'
- uses: actions/checkout@v4
if: github.event_name == 'pull_request'
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
- name: Install dependencies
run: pip3 install pydoc-markdown
- name: Render documentation
run: pydoc-markdown
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "Update documentation"
file_pattern: "docs/**"
commit_user_name: "GitHub Action"
commit_user_email: "[email protected]"

0 comments on commit 575d66b

Please sign in to comment.