Skip to content

Add skill to generate API markdown file#45877

Open
JennyPng wants to merge 5 commits intoAzure:mainfrom
JennyPng:apistub-skill
Open

Add skill to generate API markdown file#45877
JennyPng wants to merge 5 commits intoAzure:mainfrom
JennyPng:apistub-skill

Conversation

@JennyPng
Copy link
Member

@JennyPng JennyPng commented Mar 24, 2026

closes Azure/azure-sdk-tools#14656

  • edited MAX_PYTHON_VERSION -> PYTHON_VERSION_LIMIT in apistub.py, bc the name was a bit misleading and was confusing Copilot - apistub supports Python versions strictly below PYTHON_VERSION_LIMIT
image image

@JennyPng JennyPng marked this pull request as ready for review March 24, 2026 17:57
@JennyPng JennyPng requested review from Copilot and swathipil March 24, 2026 17:57
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new GitHub “skill” doc for generating API markdown via azpysdk apistub --md, and clarifies the Python version gate in apistub.py to enforce “Python < 3.12” (since apistub errors on 3.12+).

Changes:

  • Introduced .github/skills/generate-api-markdown/SKILL.md with steps to generate API markdown output.
  • Updated apistub.py to use a Python version limit tuple (3, 12) and a clearer error message for unsupported versions.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
eng/tools/azure-sdk-tools/azpysdk/apistub.py Replaces “max version” logic with a “version limit (< 3.12)” guard and updates messaging.
.github/skills/generate-api-markdown/SKILL.md Adds a skill guide documenting setup and the command to generate API markdown.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Member

@mccoyp mccoyp left a comment

Choose a reason for hiding this comment

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

LGTM in terms of skill placement and naming

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.

4 participants