Skip to content

Commit 9c8e63d

Browse files
documentation reorg
1 parent 7bdf7dc commit 9c8e63d

File tree

6 files changed

+287
-292
lines changed

6 files changed

+287
-292
lines changed

docs/api.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,21 @@ The :ref:`Asynchronous API <async_api>` classes are documented separately.
88

99
.. py:module:: elasticsearch_dsl
1010
11-
Search
12-
------
13-
1411
.. autoclass:: Search
1512
:members:
1613

1714
.. autoclass:: MultiSearch
1815
:members:
1916

20-
Document
21-
--------
22-
2317
.. autoclass:: Document
2418
:members:
2519

26-
Index
27-
-----
28-
2920
.. autoclass:: Index
3021
:members:
3122

32-
Faceted Search
33-
--------------
34-
3523
.. autoclass:: FacetedSearch
3624
:members:
3725

38-
Update By Query
39-
----------------
4026
.. autoclass:: UpdateByQuery
4127
:members:
4228

docs/async_api.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
.. _async_api:
22

3-
Asynchronous API
4-
================
3+
Asynchronous API Documentation
4+
==============================
55

66
Below please find the documentation for the asychronous classes of ``elasticsearch_dsl``.
77

88
.. py:module:: elasticsearch_dsl
99
:no-index:
1010

11-
Search
12-
------
13-
1411
.. autoclass:: AsyncSearch
1512
:inherited-members:
1613
:members:
@@ -19,30 +16,18 @@ Search
1916
:inherited-members:
2017
:members:
2118

22-
Document
23-
--------
24-
2519
.. autoclass:: AsyncDocument
2620
:inherited-members:
2721
:members:
2822

29-
Index
30-
-----
31-
3223
.. autoclass:: AsyncIndex
3324
:inherited-members:
3425
:members:
3526

36-
Faceted Search
37-
--------------
38-
3927
.. autoclass:: AsyncFacetedSearch
4028
:inherited-members:
4129
:members:
4230

43-
Update By Query
44-
----------------
45-
4631
.. autoclass:: AsyncUpdateByQuery
4732
:inherited-members:
4833
:members:

docs/howtos.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
How-To Guides
2+
=============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
search_dsl
8+
persistence
9+
faceted_search
10+
update_by_query
11+
asyncio

0 commit comments

Comments
 (0)