Skip to content
Merged
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
4 changes: 4 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ python:
- path: .
extra_requirements:
- "docs"

sphinx:
configuration: docs/sphinx/conf.py
fail_on_warning: true
149 changes: 24 additions & 125 deletions docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,129 +14,28 @@ arguments are required for all
aliased as ``from_``.


Elasticsearch
-------------

.. py:module:: elasticsearch_serverless

.. autoclass:: Elasticsearch
:members:

.. py:module:: elasticsearch_serverless.client

Async Search
------------

.. autoclass:: AsyncSearchClient
:members:

Cat
---

.. autoclass:: CatClient
:members:

Cluster
-------

.. autoclass:: ClusterClient
:members:

Connector
---------
.. py:module:: elasticsearch.client
:noindex:

.. autoclass:: ConnectorClient
:members:

Enrich Policies
---------------

.. autoclass:: EnrichClient
:members:

Event Query Language (EQL)
--------------------------

.. autoclass:: EqlClient
:members:


ES|QL
-----

.. autoclass:: EqlClient
:members:

Graph Explore
-------------

.. autoclass:: GraphClient
:members:

Indices
-------

.. autoclass:: IndicesClient
:members:

Inference
---------

.. autoclass:: InferenceClient
:members:

Ingest Pipelines
----------------

.. autoclass:: IngestClient
:members:

License
-------

.. autoclass:: LicenseClient
:members:

Logstash
--------

.. autoclass:: LogstashClient
:members:

Machine Learning (ML)
---------------------

.. autoclass:: MlClient
:members:

Monitoring
----------

.. autoclass:: MonitoringClient
:members:

Security
--------

.. autoclass:: SecurityClient
:members:

SQL
---

.. autoclass:: SqlClient
:members:

Tasks
-----

.. autoclass:: TasksClient
:members:

Transforms
----------

.. autoclass:: TransformClient
:members:
.. toctree::
:maxdepth: 1

api/elasticsearch
api/async-search
api/cat
api/cluster
api/connector
api/enrich-policies
api/eql
api/esql
api/indices
api/inference
api/ingest-pipelines
api/license
api/logstash
api/ml
api/query-rules
api/search-application
api/security
api/sql
api/synonyms
api/tasks
api/transforms
10 changes: 10 additions & 0 deletions docs/sphinx/api/async-search.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _async_search:

Async Search
------------

.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: AsyncSearchClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/cat.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _cat:

Cat
---
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: CatClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/cluster.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _cluster:

Cluster
-------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: ClusterClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/connector.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _connector:

Connector
---------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: ConnectorClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/elasticsearch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _elasticsearch:

Elasticsearch
-------------

.. py:module:: elasticsearch_serverless

.. autoclass:: Elasticsearch
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/enrich-policies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _enrich-policies:

Enrich Policies
---------------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: EnrichClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/eql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _eql:

Event Query Language (EQL)
--------------------------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: EqlClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/esql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _esql:

ES|QL
-----
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: EsqlClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/indices.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _indices:

Indices
-------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: IndicesClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/inference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _inference:

Inference
---------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: InferenceClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/ingest-pipelines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _ingest-pipelines:

Ingest Pipelines
----------------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: IngestClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/license.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _license:

License
-------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: LicenseClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/logstash.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _logstash:

Logstash
--------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: LogstashClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/ml.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _ml:

Machine Learning (ML)
---------------------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: MlClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/query-rules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _query-rules:

Query rules
-----------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: QueryRulesClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/search-application.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _search-application:

Search Applications
-------------------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: SearchApplicationClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _security:

Security
--------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: SecurityClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/sql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _sql:

SQL
---
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: SqlClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/synonyms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _synonyms:

Synonyms
--------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: SynonymsClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/tasks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _tasks:

Tasks
-----
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: TasksClient
:members:
9 changes: 9 additions & 0 deletions docs/sphinx/api/transforms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _transforms:

Transforms
----------
.. py:module:: elasticsearch_serverless.client
:noindex:

.. autoclass:: TransformClient
:members:
Loading