Skip to content

Commit 09d6fa9

Browse files
Merge pull request #657 from laughingman7743/feature/convert-docs-to-markdown
Convert documentation from RST to Markdown
2 parents ef06852 + 67b4127 commit 09d6fa9

29 files changed

+5373
-5302
lines changed

docs/api.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
(api)=
2+
3+
# API reference
4+
5+
This section provides comprehensive API documentation for all PyAthena classes and functions, organized by functionality.
6+
7+
```{toctree}
8+
:maxdepth: 2
9+
:caption: API Documentation:
10+
11+
api/connection
12+
api/converters
13+
api/utilities
14+
api/errors
15+
api/filesystem
16+
api/models
17+
api/sqlalchemy
18+
api/pandas
19+
api/arrow
20+
api/polars
21+
api/s3fs
22+
api/spark
23+
```
24+
25+
## Quick reference
26+
27+
### Core functionality
28+
29+
- {ref}`api_connection` - Connection management and basic cursors
30+
- {ref}`api_converters` - Data type conversion and parameter formatting
31+
- {ref}`api_utilities` - Utility functions and base classes
32+
- {ref}`api_errors` - Exception handling and error classes
33+
34+
### Infrastructure
35+
36+
- {ref}`api_filesystem` - S3 filesystem integration and object management
37+
- {ref}`api_models` - Athena query execution and metadata models
38+
39+
### Specialized integrations
40+
41+
- {ref}`api_sqlalchemy` - SQLAlchemy dialect implementations
42+
- {ref}`api_pandas` - pandas DataFrame integration
43+
- {ref}`api_arrow` - Apache Arrow columnar data integration
44+
- {ref}`api_polars` - Polars DataFrame integration (no pyarrow required)
45+
- {ref}`api_s3fs` - Lightweight S3FS-based cursor (no pandas/pyarrow required)
46+
- {ref}`api_spark` - Apache Spark integration for big data processing

docs/api.rst

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)