Skip to content

Commit b18e5d2

Browse files
miguelgrinberggithub-actions[bot]
authored andcommitted
Reorganization of the Sphinx docs to only include reference pages (#2776)
* add DSL module reference documentation to sphinx docs * only reference docs * renamed pages to avoid collisions with redirects (cherry picked from commit a1b458e)
1 parent d9442d0 commit b18e5d2

11 files changed

+182
-789
lines changed

docs/sphinx/api_helpers.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _helpers:
2+
3+
Helpers
4+
=======
5+
6+
.. py:module:: elasticsearch.helpers
7+
8+
Streaming Bulk
9+
--------------
10+
.. autofunction:: streaming_bulk
11+
12+
Parallel Bulk
13+
-------------
14+
.. autofunction:: parallel_bulk
15+
16+
Bulk
17+
----
18+
.. autofunction:: bulk
19+
20+
Scan
21+
----
22+
.. autofunction:: scan
23+
24+
Reindex
25+
-------
26+
.. autofunction:: reindex

docs/sphinx/async.rst

-237
This file was deleted.

docs/sphinx/async_api_helpers.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Async Helpers
2+
=============
3+
4+
Async variants of all helpers are available in ``elasticsearch.helpers``
5+
and are all prefixed with ``async_*``. You'll notice that these APIs
6+
are identical to the ones in the sync :ref:`helpers` documentation.
7+
8+
All async helpers that accept an iterator or generator also accept async iterators
9+
and async generators.
10+
11+
.. py:module:: elasticsearch.helpers
12+
:no-index:
13+
14+
Streaming Bulk
15+
--------------
16+
.. autofunction:: async_streaming_bulk
17+
18+
Bulk
19+
----
20+
.. autofunction:: async_bulk
21+
22+
Scan
23+
----
24+
.. autofunction:: async_scan
25+
26+
Reindex
27+
-------
28+
.. autofunction:: async_reindex
29+

docs/sphinx/async_dsl.rst

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _async_dsl:
2+
3+
Async DSL
4+
=========
5+
6+
.. py:module:: elasticsearch.dsl
7+
:no-index:
8+
9+
Search
10+
------
11+
.. autoclass:: AsyncSearch
12+
:inherited-members:
13+
:members:
14+
15+
Multi-Search
16+
------------
17+
.. autoclass:: AsyncMultiSearch
18+
:inherited-members:
19+
:members:
20+
21+
Document
22+
--------
23+
.. autoclass:: AsyncDocument
24+
:inherited-members:
25+
:members:
26+
27+
Index
28+
-----
29+
.. autoclass:: AsyncIndex
30+
:inherited-members:
31+
:members:
32+
33+
Mapping
34+
-------
35+
.. autoclass:: AsyncMapping
36+
:inherited-members:
37+
:members:
38+
39+
Faceted Search
40+
--------------
41+
.. autoclass:: AsyncFacetedSearch
42+
:inherited-members:
43+
:members:
44+
45+
Update by Query
46+
---------------
47+
.. autoclass:: AsyncUpdateByQuery
48+
:inherited-members:
49+
:members:

docs/sphinx/async_es_api.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Async Elasticsearch API
2+
=======================
3+
4+
.. py:module:: elasticsearch
5+
:no-index:
6+
7+
.. note::
8+
9+
To reference Elasticsearch APIs that are namespaced like ``.indices.create()``
10+
refer to the sync API reference. These APIs are identical between sync and async.
11+
12+
Elasticsearch
13+
-------------
14+
.. autoclass:: AsyncElasticsearch
15+
:members:

0 commit comments

Comments
 (0)