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.
Datos de origen
- Repositorio
- Azure/azure-sdk-for-python
- Última actividad en el origen
- 19 de junio de 2026 a las 16:03
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 5587
- Forks
- 3348
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Mostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- 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.
Ver en GitHub