Generate API Markdown
Prerequisites
- Activate your virtual environment.
- Install the required dependencies:
cd <repo_root> pip install -e ./eng/tools/azure-sdk-tools
Instructions
- Navigate to the desired package directory
- Run the command:
azpysdk apistub . - The command generates
api.mdandapi.metadata.ymlin the package directory, which are the files needed to pass the API consistency check. Provide these files to the user for review. - If the user explicitly asks for the raw APIView token file, run
azpysdk apistub . --token-fileinstead.