Skip to content

Commit be67572

Browse files
committed
PYTHON-5238 - Add async GridFS API docs
1 parent 2149567 commit be67572

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:mod:`grid_file` -- Async tools for representing files stored in GridFS
2+
=======================================================================
3+
4+
.. automodule:: gridfs.asynchronous.grid_file
5+
:synopsis: Async tools for representing files stored in GridFS
6+
7+
.. autoclass:: AsyncGridIn
8+
:members:
9+
10+
.. autoattribute:: _id
11+
12+
.. autoclass:: AsyncGridOut
13+
:members:
14+
15+
.. autoattribute:: _id
16+
.. automethod:: __aiter__
17+
18+
.. autoclass:: AsyncGridOutCursor
19+
:members:

doc/api/gridfs/asynchronous/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:mod:`gridfs async` -- Async tools for working with GridFS
2+
==========================================================
3+
4+
.. warning:: This API is currently in beta, meaning the classes, methods,
5+
and behaviors described within may change before the full release.
6+
If you come across any bugs during your use of this API,
7+
please file a Jira ticket in the "Python Driver" project at https://jira.mongodb.org/browse/PYTHON.
8+
9+
.. automodule:: gridfs.asynchronous
10+
:synopsis: Async tools for working with GridFS
11+
:members: AsyncGridFS, AsyncGridFSBucket
12+
13+
Sub-modules:
14+
15+
.. toctree::
16+
:maxdepth: 2
17+
18+
grid_file

doc/api/gridfs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
Sub-modules:
99

1010
.. toctree::
11-
:maxdepth: 2
11+
:maxdepth: 3
1212

13+
asynchronous/index
1314
errors
1415
grid_file

0 commit comments

Comments
 (0)