Skip to main content

generate-api-markdown

Generate an API markdown file and token file using ApiView. Use this when the user wants to generate an API markdown file and review API changes.

معلومات المصدر

المستودع
Azure/azure-sdk-for-python
آخر نشاط في المصدر
١٩ يونيو ٢٠٢٦ في ١٦:٠٣
لغة SKILL.md المكتشفة
الإنجليزية
النجوم
٥٬٥٨٧
التفرعات
٣٬٣٤٨

خيارات التثبيت

يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.

مراجعة ملفات المصدر

اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.

عرض SKILL.md

SKILL.md
تعليمات المصدر · معاينة للقراءة فقط
name
generate-api-markdown
description
Generate an API markdown file and token file using ApiView. Use this when the user wants to generate an API markdown file and review API changes.
# Generate API Markdown ## Prerequisites 1. Activate your virtual environment. 2. Install the required dependencies: ```bash cd <repo_root> pip install -e ./eng/tools/azure-sdk-tools ``` ## Instructions 1. Navigate to the desired package directory 2. Run the command: ```bash azpysdk apistub . ``` 3. The command generates `api.md` and `api.metadata.yml` in the package directory, which are the files needed to pass the API consistency check. Provide these files to the user for review. 4. If the user explicitly asks for the raw APIView token file, run `azpysdk apistub . --token-file` instead.
عرض على GitHub