Skip to content

Commit 81cf7d6

Browse files
Merge pull request #635 from laughingman7743/docs/fix-documentation-consistency
2 parents d94d21b + 26167a5 commit 81cf7d6

File tree

7 files changed

+86
-86
lines changed

7 files changed

+86
-86
lines changed

docs/api.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _api:
22

3-
API Reference
3+
API reference
44
=============
55

66
This section provides comprehensive API documentation for all PyAthena classes and functions, organized by functionality.
@@ -10,39 +10,39 @@ This section provides comprehensive API documentation for all PyAthena classes a
1010
:caption: API Documentation:
1111

1212
api/connection
13+
api/converters
14+
api/utilities
15+
api/errors
16+
api/filesystem
17+
api/models
18+
api/sqlalchemy
1319
api/pandas
1420
api/arrow
1521
api/s3fs
1622
api/spark
17-
api/converters
18-
api/sqlalchemy
19-
api/filesystem
20-
api/models
21-
api/utilities
22-
api/errors
2323

24-
Quick Reference
24+
Quick reference
2525
---------------
2626

27-
Core Functionality
27+
Core functionality
2828
~~~~~~~~~~~~~~~~~~
2929

3030
- :ref:`api_connection` - Connection management and basic cursors
3131
- :ref:`api_converters` - Data type conversion and parameter formatting
3232
- :ref:`api_utilities` - Utility functions and base classes
3333
- :ref:`api_errors` - Exception handling and error classes
3434

35-
Specialized Integrations
35+
Infrastructure
36+
~~~~~~~~~~~~~~~
37+
38+
- :ref:`api_filesystem` - S3 filesystem integration and object management
39+
- :ref:`api_models` - Athena query execution and metadata models
40+
41+
Specialized integrations
3642
~~~~~~~~~~~~~~~~~~~~~~~~
3743

44+
- :ref:`api_sqlalchemy` - SQLAlchemy dialect implementations
3845
- :ref:`api_pandas` - pandas DataFrame integration
3946
- :ref:`api_arrow` - Apache Arrow columnar data integration
4047
- :ref:`api_s3fs` - Lightweight S3FS-based cursor (no pandas/pyarrow required)
4148
- :ref:`api_spark` - Apache Spark integration for big data processing
42-
- :ref:`api_sqlalchemy` - SQLAlchemy dialect implementations
43-
44-
Infrastructure
45-
~~~~~~~~~~~~~~~
46-
47-
- :ref:`api_filesystem` - S3 filesystem integration and object management
48-
- :ref:`api_models` - Athena query execution and metadata models

docs/cursor.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,6 @@ AsyncS3FSCursor
329329

330330
See :ref:`async-s3fs-cursor`.
331331

332-
API Reference
333-
-------------
334-
335332
SparkCursor
336333
-----------
337334

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Documentation
1616

1717
introduction
1818
usage
19-
sqlalchemy
2019
cursor
20+
sqlalchemy
2121
pandas
2222
arrow
2323
s3fs

docs/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ PyAthena provides comprehensive support for Amazon Athena's data types and featu
4343
**Core Features:**
4444
- **DB API 2.0 Compliance**: Full PEP 249 compatibility for database operations
4545
- **SQLAlchemy Integration**: Native dialect support with table reflection and ORM capabilities
46-
- **Multiple Cursor Types**: Standard, Pandas, Arrow, and Spark cursor implementations
46+
- **Multiple Cursor Types**: Standard, Pandas, Arrow, S3FS, and Spark cursor implementations
4747
- **Async Support**: Asynchronous query execution for non-blocking operations
4848

4949
**Data Type Support:**

docs/s3fs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Execution information of the query can also be retrieved.
111111
print(cursor.service_processing_time_in_millis)
112112
print(cursor.output_location)
113113
114-
Type Conversion
114+
Type conversion
115115
~~~~~~~~~~~~~~~
116116

117117
S3FSCursor converts Athena data types to Python types using the built-in converter.
@@ -172,7 +172,7 @@ Then specify an instance of this class in the converter argument when creating a
172172
cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
173173
region_name="us-west-2").cursor(S3FSCursor, converter=CustomS3FSTypeConverter())
174174
175-
CSV Reader Options
175+
CSV reader options
176176
~~~~~~~~~~~~~~~~~~
177177

178178
S3FSCursor supports pluggable CSV reader implementations to control how NULL values and empty strings

0 commit comments

Comments
 (0)