Skip to content

chore: Add job to generate api docs - #62

Open
marikaner wants to merge 4 commits into
sphinxfrom
api-doc-job
Open

chore: Add job to generate api docs#62
marikaner wants to merge 4 commits into
sphinxfrom
api-doc-job

Conversation

@marikaner

Copy link
Copy Markdown
Contributor

No description provided.

@marikaner
marikaner requested a review from alpkom as a code owner August 14, 2026 07:12
@marikaner
marikaner requested review from mwien and yamaceay August 14, 2026 07:12
Comment thread .github/workflows/api-doc.yml Fixed
Comment thread .github/workflows/api-doc.yml Fixed
Comment thread .github/workflows/api-doc.yml Fixed
@marikaner
marikaner changed the base branch from main to sphinx August 14, 2026 07:13
Comment thread .github/workflows/api-doc.yml Fixed

@yamaceay yamaceay left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job, just some minor feedbacks :)

env:
TAG: ${{ github.ref_name }}
run: |
BRANCH="api-docs-python-$TAG-$(date +%Y%m%d)"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: I wanted to ask whether it could be a problem that we generate multiple api docs per day. Maybe, it makes sense to add a 5-6 char long salt at the end to randomize it?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pp: I think we can stack #64 on top of this PR too, since it affects similar files.

permission-pull-requests: write

- name: Setup
uses: SAP/ai-sdk-python/.github/actions/setup@main

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: Is it intended that we don't pin this branch to a SHA?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants