Skip to content

Hotfix: Docs GH Action Looping Infinitely #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# This workflow will install Python dependencies and generate Markdown
# documentation from docstrings using Sphinx. We generate the HTML
# documentation to keep it up to date with the Markdown files

name: Python Library API docs

on:
push:
branches:
- main
- release-v1
paths-ignore:
- 'docs/_build/**'
workflow_dispatch:
inputs:
note:
description: "Provide a description of the changes"
description: 'Provide a description of the changes'
required: true
default: "Update docs"
default: 'Update docs'

permissions:
contents: write
Expand All @@ -35,8 +36,8 @@ jobs:
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: "poetry"
python-version: '3.11'
cache: 'poetry'

- name: Install Dependencies
run: |
Expand All @@ -52,5 +53,5 @@ jobs:
uses: EndBug/add-and-commit@v9
with:
default_author: github_actions
message: "Generate docs"
add: "docs/_build/"
message: 'Generate docs'
add: 'docs/_build/'