# Documentation

This folder contains documentation for the Azure SDK for Python repository.

## General

- [Python Version Support Policy](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/python_version_support_policy.md) - Supported Python versions and end-of-support dates
- [Engineering System Checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) - What a standard `ci.yml` will execute
- [Deprecation Process](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/deprecation_process.md) - How to deprecate a package
- [Repository Health Status](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/repo_health_status.md) - Library health status definitions
- [ESRP Release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/esrp_release.md) - ESRP release process
- [Request Builders](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/request_builders.md) - Request builder pattern documentation
- [Send Request](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/send_request.md) - Send request pattern documentation
- [Analyze Check Versions](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/analyze_check_versions.md) - Check version analysis
- [Tool Usage Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/tool_usage_guide.md) - How to use the `azpysdk` CLI tool

## Developer Documentation

See the [dev](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/) folder for documentation aimed at developers of SDK libraries:

- [Developer Setup](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dev_setup.md) - How to create a development environment
- [Release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/release.md) - How to release a package
- [Packaging](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/packaging.md) - How to organize packaging information
- [Changelog Updates](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/changelog_updates.md) - How to document package changes
- [Testing](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md) - How to write unit and functional tests
- [Advanced Testing](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests-advanced.md) - Advanced testing topics
- [Docstrings](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/docstring.md) - How to document an SDK
- [Type Checking](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking.md) - Type hints and type checking ([Cheatsheet](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking_cheat_sheet.md))
- [Pylint](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/pylint_checking.md) - Pylint checking guidance
- [Sample Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/sample_guide.md) - How to write SDK samples
- [Performance Testing](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/perfstress_tests.md) - How to write and run perf tests
- [Debug Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/debug_guide.md) - Debugging tips
- [Code Snippets](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/code_snippets.md) - How to include code snippets in docs

### Troubleshooting & Common Issues

- [Common Issues and FAQ](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/common_issues.md) - Common SDK issues and how to resolve them
- [Test Proxy Troubleshooting](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/test_proxy_troubleshooting.md) - Test proxy issues

### Code Generation

- [Dataplane SDK Generation](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dataplane_generation.md) - Generate a dataplane SDK from a TypeSpec definition
- [Management Plane](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/) - Management plane SDK documentation

### Additional Topics

- [Customize Long Running Operations](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_long_running_operation.md) - LRO customization
- [CredScan Process](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/credscan_process.md) - Credential scanning
- [Recording Migration Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/recording_migration_guide.md) - Migrating test recordings
- [Engineering Assumptions](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/engineering_assumptions.md) - SDK engineering assumptions
- [Conda Builds](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/conda-builds.md) / [Release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/conda-release.md) / [Dev Release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/conda-release-dev.md) - Conda packaging

## Sphinx Reference Documentation

The [sphinx](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/sphinx/) folder contains the documentation source for https://azure.github.io/azure-sdk-for-python/.
