Skip to content

feat: automate docs generation. (#710) #4

feat: automate docs generation. (#710)

feat: automate docs generation. (#710) #4

Workflow file for this run

name: Generate API docs
on:
push:
branches:
- development
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install pydoc-markdown
- name: Run pydoc-markdown
working-directory: .
run: |
pydoc-markdown pydoc-markdown.yml
- name: Create Pull Request if docs changed
uses: peter-evans/create-pull-request@v7
with:
branch: docs/regenerate-api-docs
commit-message: chore(docs): regenerate API docs

Check failure on line 33 in .github/workflows/docs.yaml

View workflow run for this annotation

GitHub Actions / .github/workflows/docs.yaml

Invalid workflow file

You have an error in your yaml syntax on line 33
title: chore(docs): regenerate API docs
body: |
This PR was automatically generated by the workflow to regenerate the API documentation.
add-paths: |
docs/api-reference/python/**
delete-branch: true