Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganization of the Sphinx docs to only include reference pages #2776

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/sphinx/api_helpers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _helpers:

Helpers
=======

.. py:module:: elasticsearch.helpers

Streaming Bulk
--------------
.. autofunction:: streaming_bulk

Parallel Bulk
-------------
.. autofunction:: parallel_bulk

Bulk
----
.. autofunction:: bulk

Scan
----
.. autofunction:: scan

Reindex
-------
.. autofunction:: reindex
237 changes: 0 additions & 237 deletions docs/sphinx/async.rst

This file was deleted.

29 changes: 29 additions & 0 deletions docs/sphinx/async_api_helpers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Async Helpers
=============

Async variants of all helpers are available in ``elasticsearch.helpers``
and are all prefixed with ``async_*``. You'll notice that these APIs
are identical to the ones in the sync :ref:`helpers` documentation.

All async helpers that accept an iterator or generator also accept async iterators
and async generators.

.. py:module:: elasticsearch.helpers
:no-index:

Streaming Bulk
--------------
.. autofunction:: async_streaming_bulk

Bulk
----
.. autofunction:: async_bulk

Scan
----
.. autofunction:: async_scan

Reindex
-------
.. autofunction:: async_reindex

49 changes: 49 additions & 0 deletions docs/sphinx/async_dsl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _async_dsl:

Async DSL
=========

.. py:module:: elasticsearch.dsl
:no-index:

Search
------
.. autoclass:: AsyncSearch
:inherited-members:
:members:

Multi-Search
------------
.. autoclass:: AsyncMultiSearch
:inherited-members:
:members:

Document
--------
.. autoclass:: AsyncDocument
:inherited-members:
:members:

Index
-----
.. autoclass:: AsyncIndex
:inherited-members:
:members:

Mapping
-------
.. autoclass:: AsyncMapping
:inherited-members:
:members:

Faceted Search
--------------
.. autoclass:: AsyncFacetedSearch
:inherited-members:
:members:

Update by Query
---------------
.. autoclass:: AsyncUpdateByQuery
:inherited-members:
:members:
15 changes: 15 additions & 0 deletions docs/sphinx/async_es_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Async Elasticsearch API
=======================

.. py:module:: elasticsearch
:no-index:

.. note::

To reference Elasticsearch APIs that are namespaced like ``.indices.create()``
refer to the sync API reference. These APIs are identical between sync and async.

Elasticsearch
-------------
.. autoclass:: AsyncElasticsearch
:members:
Loading