Skip to content

Commit ed138c9

Browse files
Convert documentation from RST to Markdown using MyST-Parser
Replace all 25 .rst files under docs/ with MyST Markdown equivalents, add myst-parser as a dev dependency, and configure Sphinx to support both .rst and .md source files for backward compatibility with older tagged branches. Closes #652. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e2938c7 commit ed138c9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+5834
-5818
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.

docs/api/arrow.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
(api_arrow)=
2+
3+
# Apache Arrow Integration
4+
5+
This section covers Apache Arrow-specific cursors, result sets, and data converters.
6+
7+
## Arrow Cursors
8+
9+
```{autoclass} pyathena.arrow.cursor.ArrowCursor
10+
:members:
11+
:inherited-members:
12+
```
13+
14+
```{autoclass} pyathena.arrow.async_cursor.AsyncArrowCursor
15+
:members:
16+
:inherited-members:
17+
```
18+
19+
## Arrow Result Set
20+
21+
```{autoclass} pyathena.arrow.result_set.AthenaArrowResultSet
22+
:members:
23+
:inherited-members:
24+
```
25+
26+
## Arrow Data Converters
27+
28+
```{autoclass} pyathena.arrow.converter.DefaultArrowTypeConverter
29+
:members:
30+
```
31+
32+
```{autoclass} pyathena.arrow.converter.DefaultArrowUnloadTypeConverter
33+
:members:
34+
```
35+
36+
## Arrow Utilities
37+
38+
```{autofunction} pyathena.arrow.util.to_column_info
39+
```
40+
41+
```{autofunction} pyathena.arrow.util.get_athena_type
42+
```

docs/api/arrow.rst

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

docs/api/connection.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
(api_connection)=
2+
3+
# Connection and Cursors
4+
5+
This section covers the core connection functionality and basic cursor operations.
6+
7+
## Connection
8+
9+
```{automodule} pyathena
10+
:members: connect
11+
```
12+
13+
```{autoclass} pyathena.connection.Connection
14+
:members:
15+
:inherited-members:
16+
```
17+
18+
## Standard Cursors
19+
20+
```{autoclass} pyathena.cursor.Cursor
21+
:members:
22+
:inherited-members:
23+
```
24+
25+
```{autoclass} pyathena.cursor.DictCursor
26+
:members:
27+
:inherited-members:
28+
```
29+
30+
## Asynchronous Cursors
31+
32+
```{autoclass} pyathena.async_cursor.AsyncCursor
33+
:members:
34+
:inherited-members:
35+
```
36+
37+
```{autoclass} pyathena.async_cursor.AsyncDictCursor
38+
:members:
39+
:inherited-members:
40+
```
41+
42+
## Result Sets
43+
44+
```{autoclass} pyathena.result_set.AthenaResultSet
45+
:members:
46+
:inherited-members:
47+
```
48+
49+
```{autoclass} pyathena.result_set.AthenaDictResultSet
50+
:members:
51+
:inherited-members:
52+
```
53+
54+
```{autoclass} pyathena.result_set.WithResultSet
55+
:members:
56+
```

docs/api/connection.rst

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

docs/api/converters.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
(api_converters)=
2+
3+
# Data Conversion
4+
5+
This section covers data type converters and parameter formatters.
6+
7+
## Type Converters
8+
9+
```{autoclass} pyathena.converter.Converter
10+
:members:
11+
```
12+
13+
```{autoclass} pyathena.converter.DefaultTypeConverter
14+
:members:
15+
```
16+
17+
## Parameter Formatters
18+
19+
```{autoclass} pyathena.formatter.Formatter
20+
:members:
21+
```
22+
23+
```{autoclass} pyathena.formatter.DefaultParameterFormatter
24+
:members:
25+
```

docs/api/converters.rst

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

0 commit comments

Comments
 (0)